Remove Group Member

API Type

REST

HTTP Method

POST

Description

Removes a member from a group.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
GroupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.
UserName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.

These properties are based on the class RemoveGroupMemberHelper

JavaScript Code Example

$("#btnRemoveGroupMember").click(function () {
  
  var JSONObject = { 
    GroupName: "test1234", 
    UserName: "demo3\\brian.lucas"
  };
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RemoveGroupMember",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String RemoveGroupMember(String GroupName, String UserName) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/RemoveGroupMember";

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("GroupName", GroupName);
    postData.put("UserName", UserName);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string RemoveGroupMember(string username)
  {
    string URL = "http://mydomain:9011/AgilePointServer/Admin/RemoveGroupMember";

    string jsonRequestData = "{
      \"GroupName\":\"" + "Administrators" + "\",
      \"UserName\":\"" + username + "\"}";

    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