Get Domain Users

API Type

REST

HTTP Method

POST

Description

Retrieves all the user information in the domain that AgilePoint Server connects. It could be a local Windows system user, or a domain controller on the network.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Request Body Properties

JavaScript Code Example

$("#btnGetDomainUsers").click(function () {
  var JSONObject = {
    LDAPPath: "LDAP://OU=people,DC=mydomain,DC=com",
    Filter: "(objectCategory=person)"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetDomainUsers",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetDomainUsers() {

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

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

  
    JSONObject postData = new JSONObject();
    postData.put("LDAPPath", "LDAP://OU=people,DC=mydomain,DC=com");
    postData.put("Filter", "(objectCategory=person)");

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

C# Code Example

public string GetDomainUsers()
  {
    string jsonRequestData = "{
      \"LDAPPath\":\"LDAP:\\/\\/OU=people,
      DC=demo3,
      DC=com\",
      \"Filter\":\"(objectCategory=person)\"}";

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

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

Array of DomainUser objects. If the specified group does not exist, the return value is null.

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