List Active Directory Users
Service name: list_active_directory_users
API Call Frequency:To avoid performance issues, do not send more than 60 API calls in 1 minute. We may contact you if we detect API activity that negatively impacts system performance.
Base URL
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_active_directory_usersDescription
Lists Active Directory user details for a the specified site.
The Active Directory Automated Task retrieves a list of users, including those who have been recently added, modified or deleted in Active Directory. Retrieving this Active Directory Users information via an API call is useful for automating user data management, integrating with other systems, and enhancing security. It saves time, reduces errors, and allows seamless synchronization with platforms like CRM or HR systems. Additionally, it supports reporting, auditing, and efficient user management. Using this API call helps you scale you user management processes, monitor for unauthorized changes, and ensure compliance with security policies.
Parameters
Required parameters
Add required parameters immediately after the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_active_directory_users&required_parameters={parameter-value}| Parameter | Description | Type | Options | Default |
|---|---|---|---|---|
| siteid | The identifier for the target site. | integer | 0 | 0 |
Optional parameters
Add optional parameters after the required parameters in the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_active_directory_users&required_parameters={parameter-value}&optional_parameters={parameter-value}| Parameter | Description | Type | Options | Default |
|---|---|---|---|---|
| describe | Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions. | boolean | true | 0 |
Determine parameter values
Use the following associated service calls to determine parameter values.
| Parameter | Call | URL Format |
|---|---|---|
| siteid | list_sites | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_sites&clientid=CLIENTID |
| clientid | list_clients | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients |
Examples
List Active Directory users for a site
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_active_directory_users&siteid=SITEIDExample response
<result created="2012-05-25T16:32:31+01:00" host="SERVER" status="OK">
<users count="156" updated="2012-05-24T22:35:01+01:00">
<user objectGUID="0020A0AA4A3AD74898C7985F252CECBC" status="3" device="168510">
<distinguishedName>
<![CDATA[
CN=MT Support Sharepoint,OU=Mail Accounts,OU=Technical Support,OU=Inverness,OU=Office Locations,DC=test,DC=com
]]>
</distinguishedName>
<mail>
<![CDATA[ [email protected] ]]>
</mail>
<givenName>
<![CDATA[ MT Support ]]>
</givenName>
<sn>
<![CDATA[ Sharepoint ]]>
</sn>
<displayName>
<![CDATA[ MT Support Sharepoint ]]>
</displayName>
<userPrincipalName>
<![CDATA[ [email protected] ]]>
</userPrincipalName>
<description>
<![CDATA[ Support Department Sharepoint Server ]]>
</description>
<department>
<![CDATA[ Support ]]>
</department>
<pwdLastSet>1230629179</pwdLastSet>
<whenCreated>1230628385</whenCreated>
<whenChanged>1336942843</whenChanged>
</user>
....
</result>Field descriptions
Field | Type | Can Be Empty | Description |
|---|---|---|---|
user@objectGUID | string (hex) | no | objectGUID LDAP property, which is used as the user object's unique identifier and always queried |
user@status | integer | no | Status ID: |
user@device | integer | no | Identifier of the device at which the user was found |
user/< any > | no | This section contains any populated user field that is selected as an Available Field for the Active Directory Users Query Automated Task and matches a valid LDAP display name. |
Values returned from Active Directory are not always strings, but the script attempts to convert all values to strings. Date objects are converted to timestamps (UTC epoch). If a value is null then that field (index) for the user is omitted.
Updated about 1 month ago