GET
/scim_directories/{scim_directory_id}Retrieve a SCIM directory
Retrieves the configuration for a SCIM directory. Use its identifier to look up details such as its provider, endpoint URL, enabled state, and attribute mappings.
scim_directory_idstringrequired
The ID of the SCIM directory to retrieve.
200Returns the directory configuration, including its identifier, name, associated enterprise connection, endpoint URL, provider, settings, attribute mappings, and timestamps.
objectstringrequired
String representing the object's type. Always "scim_directory".
idstringrequired
Unique identifier for the directory.
namestringrequired
A human-friendly name for the directory.
enterprise_connection_idstringoptional
The ID of the associated enterprise connection.
endpoint_urlstringrequired
The SCIM endpoint URL for this directory.
providerstringrequired
The identity provider for this directory.
enabledbooleanrequired
Whether the directory is enabled.
group_role_mapping_enabledbooleanrequired
Whether group-to-role mapping is enabled for this directory.
attribute_mappingobjectrequired
Mapping of user attributes to the SCIM attribute paths they are extracted from.
custom_attributesarray<object>optional
Custom attributes to map from the IdP to the user's profile via SCIM provisioning. Requires the custom attributes feature to be enabled for the instance.
api_keystringoptional
The API key for authenticating SCIM requests. Only returned when the directory is created or the key is rotated.
created_atintegerrequired
Unix timestamp when the directory was created.
updated_atintegerrequired
Unix timestamp when the directory was last updated.
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the directory is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
A 401 indicates invalid authentication, a 403 indicates invalid authorization, and a 404 indicates the directory was not found. The scim_directory_id path parameter must identify the directory to retrieve.