JUjumpcloud
Active Directory

Get an Active Directory

This endpoint returns a specific Active Directory.

Sample Request

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

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

domainstring

Domain name for this Active Directory instance.

idstring

ObjectID of this Active Directory instance.

useCase'UNSET' | 'TWOWAYSYNC' | 'JCASAUTHORITY' | 'ADASAUTHORITY'
groupsEnabledboolean
delegationState'ENABLED' | 'PENDING' | 'DISABLED'

Delegation state of the Active Directory instance

primaryAgentstring

ObjectID of the primary sync agent of domain.

primaryImportAgentstring

ObjectID of the primary import agent of domain.

updatedAtstring date-time nullable
permission'PERMISSION_UNSPECIFIED' | 'PERMISSION_OWNER' | 'PERMISSION_READ_ONLY'

Permission level for the Active Directory domain.

organizationIdstring

ObjectID of the organization that owns this Active Directory instance.

associatedOrganizationIdsstring[]

Organization object ids (hex) where this Active Directory integration is associated among the caller's authorized organizations.

Changes

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