Unregister User

API Type

REST

HTTP Method

POST

Description

Removes a user's registration from the AgilePoint system. Note that this call does not remove the user from the local Windows system or the domain controller.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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",
    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", "demo3\\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);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher