Clerk API (unofficial showcase)
GET/saml_connections/{saml_connection_id}Deprecated

Retrieve a SAML Connection by ID

Fetches the SAML Connection whose ID matches the provided saml_connection_id in the path. Deprecated: Use the Enterprise Connections API instead. This endpoint will be removed in future versions.

1 parameter
saml_connection_idstringrequired
The ID of the SAML Connection

4 status codes
200A SAML Connection
objectstringrequired
Allowed:saml_connection
idstringrequired
namestringrequired
domainstringdeprecatedoptional
domainsarray<string>optional
idp_entity_idstringrequired
idp_sso_urlstringrequired
idp_certificatestringrequired
idp_certificate_issued_atintegerrequired
Unix timestamp (milliseconds) of the start of the IdP certificate validity window (X.509 NotBefore). Null when no certificate is configured.
idp_certificate_expires_atintegerrequired
Unix timestamp (milliseconds) of the end of the IdP certificate validity window (X.509 NotAfter). Null when no certificate is configured.
idp_certificatesarray<object>required
Every IdP signing certificate the connection trusts, primary first. A SAML response verifies against any of them.
idp_metadata_urlstringoptional
idp_metadatastringoptional
acs_urlstringrequired
sp_entity_idstringrequired
sp_metadata_urlstringrequired
organization_idstringoptional
attribute_mappingobjectoptional
activebooleanrequired
providerstringrequired
user_countintegerrequired
sync_user_attributesbooleanrequired
allow_subdomainsbooleanrequired
allow_idp_initiatedbooleanrequired
disable_additional_identificationsbooleanrequired
allow_organization_account_linkingbooleanrequired
force_authnbooleanrequired
Enable or deactivate ForceAuthn
login_hintobjectrequired
Configuration for the login_hint sent to the IdP on SSO sign-in
enterprise_connection_idstringoptional
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
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.