Enterprise Connections

Create an enterprise connection

Changed on

Create a new enterprise connection.

post/enterprise_connections

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/enterprise_connections
  • Auth: HTTP bearer

Request body

namestring required

The display name of the connection

provider'saml_custom' | 'saml_okta' | 'saml_google' | 'saml_microsoft' | 'oidc_custom' | 'oidc_github_enterprise' | 'oidc_gitlab' required

The identity provider (e.g. saml_custom, oidc_custom, oidc_github_enterprise, oidc_gitlab)

domainsstring[] required

Domains associated with the enterprise connection (required; at least one). Values are normalized to lowercase. Each domain must be a valid fully qualified domain name.

organization_idstring nullable

Organization ID when the connection is linked to an organization

allow_organization_account_linkingboolean nullable

Whether this connection supports account linking via organization membership

activeboolean nullable

Whether the enterprise connection is active. When true, IdP metadata must be provided via the saml object.

Response

An enterprise connection

object'enterprise_connection' required
idstring required

The enterprise connection ID

namestring required

The display name of the connection

providerstring required
logo_public_urlstring nullable
activeboolean required

Whether the enterprise connection is active

domainsstring[] required

Domains associated with the enterprise connection

organization_idstring nullable

Organization ID when the connection is linked to an organization

sync_user_attributesboolean

Controls whether to update the user's attributes on each sign-in

disable_additional_identificationsboolean

When true, users cannot add additional identifications when using this connection

allow_organization_account_linkingboolean

Whether this connection supports account linking via organization membership

created_atinteger required

Unix timestamp in milliseconds when the connection was created

updated_atinteger required

Unix timestamp in milliseconds when the connection was last updated

Changes

  • 2025-11-10896a452e4c0cRevision changes
    • info

      added the new optional request property /

    • info

      request property / deprecated

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 2025-11-10f0ead9fddcd6Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status