Get Domain Group Members

API Type

REST

HTTP Method

POST

Description

Retrieves the members of a group in the Active Directory domain.

Good to Know

  • This method is used only for AgilePoint internal purposes.
  • The distinguished name of the group in the LDAP format is required in the groupDistinguishedName parameter.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

groupDistinguishedName
Function:
Specifies the name of a group in LDAP format.
Type
string
Accepted 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 URI = "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroupMembers";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);
  
    JSONObject postData = new JSONObject();
    postData.put("groupDistinguishedName", "LDAP:\\/\\/adHocAdmin");

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

C# Code Example

public string GetDomainGroupMembers()
  {
    string jsonRequestData = "{
      \"groupDistinguishedName\":\"LDAP:\\/\\/adHocAdmin\"}";

    string URL = "https://mydomain:9011/AgilePointServer/Admin/GetDomainGroupMembers";

    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 {\"groupDistinguishedName\":\"WinNT:\/\/mydomain\"} 
                         https://mydomain:9011/AgilePointServer/Admin/GetDomainGroupMembers

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 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.