Get Domain Group Members

API Type

REST

HTTP Method

POST

Description

Retrieves the members of a domain group.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
groupDistinguishedName	Definition: Specifies the name of a group in LDAP format. Type string Allowed Values: A valid a group name in LDAP format.

JavaScript Code Example

$("#btnGetDomainGroupMembers").click(function () {
  var JSONObject = { groupDistinguishedName: "LDAP:\/\/adHocAdmin"}; 
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroupMembers",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetDomainGroupMembers(String groupName) {

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

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("groupDistinguishedName", groupName);

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

Output

An array of DomainUser objects.

JSON Response Body Example

{
  "Department":"String content",
  "EMailAddress":"String content",
  "FullName":"String content",
  "Manager":"String content",
  "MemberOf":["String content"],
  "Title":"String content",
  "UserName":"String content"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher