JUjumpcloud
Active Directory

Create a new Active Directory Agent

This endpoint allows you to create a new Active Directory Agent.

Sample Request

curl -X POST 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}' \
  -d '{ "agent_type":"{SYNC}" }'
post/activedirectories/{activedirectory_id}/agents

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

agentType'SYNC' | 'IMPORT'

Response

connectKeystring

The connect key to use when installing the Agent on a Domain Controller.

contactAtstring nullable
hostnamestring nullable
hostTypestring nullable

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

idstring required

ObjectID of this Active Directory Agent.

passwordUpdatedAtstring date-time nullable
source_ipstring nullable
state'unsealed' | 'active' | 'inactive'
versionstring nullable

Changes

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