Unregister User

API Type

REST

HTTP Method

POST

Description

Permanently removes a user from the AgilePoint system.

Good to Know

• This does not remove the user from the local Windows system or the domain controller.
• If the user has a group task assigned, the user continues to see the task until another group member takes assignment for the task.
• The exception is a Dynamic Group task, which is immediately removed from the user's task list.

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Admin/UnregisterUser

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Admin/UnregisterUser

Request Parameters

Request Body Properties

JavaScript Code Example

$("#btnUnregisterUser").click(function () {

  var JSONObject = { userName: "sg1" };

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/UnregisterUser",
    dataType: "text",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String UnregisterUser() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/UnregisterUser";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  
    JSONObject postData = new JSONObject();
    postData.put("userName", "mydomain\\administrator");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UnregisterUser()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Admin/UnregisterUser";

    string jasonRequestData = "{\"userName\":\"" + "sg1" + "\"}";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URI, jasonRequestData);
  }

cURL Code Example

curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"userName\":\"mydomain\\brian.lucas\"} 
                         https://mydomain:9011/AgilePointServer/Admin/UnregisterUser

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

• AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
• Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
• Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.