Sign in
SCIM Directories

Retrieve a directory

Returns the details of a directory.

get/scim_directories/{scim_directory_id}

Path parameters

scim_directory_idstring required

The ID of the directory to retrieve

Response

A directory

object'scim_directory' required

String representing the object's type. Always "scim_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 SCIM endpoint URL for this directory.

providerstring required

The identity provider for this directory.

enabledboolean required

Whether the directory is enabled.

group_role_mapping_enabledboolean required

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

attribute_mappingobject required

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

api_keystring nullable

The API key for authenticating SCIM 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

Changed in 2 of the 15 revisions of this API.2