Remove Group Member

API Type

REST

HTTP Method

POST

Description

Permanently removes a user member from a specified group.

Good to Know

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, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
GroupName	Description: Specifies the name of a group. Type string Allowed Values: A valid group name.
UserName	Description: 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: "mydomain\\brian.lucas"
  };
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RemoveGroupMember",
    dataType: "text",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String RemoveGroupMember() {

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

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

  
    JSONObject postData = new JSONObject();
    postData.put("GroupName", "Regional HR");
    postData.put("UserName", "mydomain\\brian.lucas");

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

C# Code Example

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

    string jsonRequestData = "{
      \"GroupName\":\"" + "Administrators" + "\",
      \"UserName\":\"" + "mydomain\\brian.lucas" + "\"}";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.

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

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.