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

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Filter	Definition: A filter term for groups that is wildcard-enabled. Type string Allowed Values: A string in the format (name=[my wildcard filter]).
LDAPPath	Definition: The LDAP path to the domain. Type string Allowed Values: A valid LDAP path. If the value is null, the AgilePoint Server machine domain will be used.

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 LDAPPath, String Filter) {

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

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("LDAPPath", LDAPPath);
    postData.put("Filter", Filter);

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

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