JUjumpcloud
Active Directory

List Active Directory Agents

This endpoint allows you to list all your Active Directory Agents for a given Instance.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/api/v2/activedirectories/{activedirectory_id}/agents

Request

Query parameters

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

contactAtstring nullable
hostnamestring nullable
hostTypestring nullable

Host role reported by the agent (DOMAIN_CONTROLLER or MEMBER_SERVER).

idstring

ObjectID of this Active Directory Agent.

passwordUpdatedAtstring date-time nullable
source_ipstring nullable
state'unsealed' | 'active' | 'inactive'
agentType'SYNC' | 'IMPORT'
versionstring nullable
idSourceIdstring nullable

ObjectID of this Active Directory Agent in IdSource table.

Changes

No recorded changes to this operation across all 1 revision of this API.