JUjumpcloud
Active Directory

Update Active Directory

This endpoint allows you to update Active Directory. Here use case can be one of:

  • AD as Authority - password in AD - 2-way sync use case is selected.
  • JC as Authority - one-way sync from AD.
  • Two way sync - 2-way sync use case is selected

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/activedirectories/{Domain_ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
        "domain": "{DC=DOMAIN;DC=COM}",
        "use_case": "{ADASAUTHORITY}",
        "delegation_state": "{ENABLED}"
    }' \
patch/api/v2/activedirectories/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

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.

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.