Remove Role Member

API Type

REST

HTTP Method

POST

Description

Removes a user or a group from a specified role.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Request Body Properties

These properties are based on the class RemoveRoleMemberHelper

JavaScript Code Example

$("#btnRemoveRoleMember").click(function () {
  
  var JSONObject = { 
    RoleName: "Administrators", Assignee: "demo3\\brian.lucas", 
    AssigneeType: "User", 
    ObjectID: "00000000000000000000000000000000"
    };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RemoveRoleMember",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String RemoveRoleMember() {

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

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

  JSONObject postData = new JSONObject();
  
    postData.put("RoleName", "Administrators");
    postData.put("Assignee", "demo3\\brian.lucas");
    postData.put("AssigneeType", "User");
    postData.put("ObjectID", "00000000000000000000000000000000");
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string RemoveRoleMember()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Admin/RemoveRoleMember";

    string jsonRequestData = "{
      \"RoleName\":\"" + "Administrators" + "\",
      \"Assignee\":\"" + "demo3\\brian.lucas" + "\",
      \"AssigneeType\":\"" + "User" + "\",
      \"ObjectID\":\"" + "00000000000000000000000000000000" + "\"}";

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

    return ops.POSTMethod(URL,jsonRequestData);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher