JUjumpcloud
Directories

List All Directories

This endpoint returns all active directories (LDAP, O365 Suite, G-Suite).

Sample Request

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

Filter by organizationId

Supported filter field: organizationId. Supported operators: eq, in.

 curl -X GET 'https://console.jumpcloud.com/api/v2/directories?filter=organizationId:eq:{ORG_ID}' \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/api/v2/directories

Request

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.

sortstring[]

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

skipinteger

The offset into the records to return.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

idstring required

The ObjectID of the directory.

namestring required

The name of the directory.

type'active_directory' | 'g_suite' | 'ldap_server' | 'office_365' | 'workday' required

The type of directory.

oAuthStatusobject nullable

the expiry and error status of the bearer token

organizationIdstring

ObjectID of the organization that owns this directory.

associatedOrganizationIdsstring[]

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

Changes

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