JUjumpcloud
Providers
Active Directory

List Active Directories

This endpoint allows you to list all your Active Directory Instances for a Providers primary organization.

Sample Request

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

Request

Path parameters

provider_idstring required

The ID of the provider

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

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

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.