Vee3

Get Clerk enterprise connection

Retrieve a single enterprise SSO connection from a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/enterprise-connections/{connection_id}

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}

3 tokens

Retrieve a single enterprise SSO connection from a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.get_enterprise_connection
Parameters2 fields
clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

Response36 fields
enterprise_connectionobject
35 fields

Enterprise SSO connection details.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems
5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject
9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject
6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required