GET/enterprise_connections/{enterprise_connection_id}

Retrieve an enterprise connection

Fetches the enterprise connection whose ID matches the provided enterprise_connection_id in the path.

1 parameter
enterprise_connection_idstringrequired
The ID of the enterprise connection

4 status codes
200An enterprise connection
objectstringrequired
Allowed:enterprise_connection
idstringrequired
The enterprise connection ID
namestringrequired
The display name of the connection
providerstringrequired
logo_public_urlstringoptional
activebooleanrequired
Whether the enterprise connection is active
domainsarray<string>required
Domains associated with the enterprise connection
organization_idstringoptional
Organization ID when the connection is linked to an organization
sync_user_attributesbooleanoptional
Controls whether to update the user's attributes on each sign-in
disable_additional_identificationsbooleanoptional
When true, users cannot add additional identifications when using this connection
allow_organization_account_linkingbooleanoptional
Whether this connection supports account linking via organization membership
custom_attributesarray<object>optional
Custom attributes to map from the IdP to the user's profile via SSO or SCIM provisioning
saml_connectionobjectoptional
Present when the enterprise connection uses SAML
oauth_configobjectoptional
Present when the enterprise connection uses OIDC or EASIE
created_atintegerrequired
Unix timestamp in milliseconds when the connection was created
updated_atintegerrequired
Unix timestamp in milliseconds when the connection was last updated
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 402 is returned: Payment required. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found.