Directories

Retrieve a directory

Changed on

Returns the details of a directory.

get/directories/{directory_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/directories/{directory_id}
  • Auth: HTTP bearer

Path parameters

directory_idstring required

The ID of the directory to retrieve

Response

A directory

object'directory' required

String representing the object's type. Always "directory".

idstring required

Unique identifier for the directory.

namestring required

A human-friendly name for the directory.

enterprise_connection_idstring nullable

The ID of the associated enterprise connection.

endpoint_urlstring required

The provisioning endpoint URL for this directory.

providerstring required

The identity provider for this directory.

enabledboolean required

Whether the directory is enabled.

pausedboolean required

Whether syncing is paused. A paused directory rejects provisioning requests and skips scheduled syncs, but keeps the organization memberships it granted. Disabling a directory removes them instead.

group_role_mapping_enabledboolean required

Whether group-to-role mapping is enabled for this directory.

attribute_mappingobject required

Mapping of user attributes to the directory attribute paths they are extracted from.

api_keystring nullable

The API key for authenticating provisioning requests. Only returned when the directory is created or the key is rotated.

created_atinteger required

Unix timestamp when the directory was created.

updated_atinteger required

Unix timestamp when the directory was last updated.

Changes