SAML Connections

Update a SAML Connection

Changed on

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

patch/saml_connections/{saml_connection_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/saml_connections/{saml_connection_id}
  • Auth: HTTP bearer

Path parameters

saml_connection_idstring required

The ID of the SAML Connection to update

Request body

namestring nullable

The name of the new SAML Connection

domainstring nullable

The domain to use for the new SAML Connection

domainsstring[] nullable

A list of the domains on use for the SAML connection

idp_entity_idstring nullable

The Entity ID as provided by the IdP

idp_sso_urlstring nullable

The SSO URL as provided by the IdP

idp_certificatestring nullable

Deprecated, use idp_certificates. One X.509 certificate, PEM or bare base64, or several concatenated PEM certificates; replaces the connection's whole certificate set

idp_certificatesstring[]

The IdP X.509 signing certificates the connection trusts, one per entry, in PEM or bare base64. Replaces the connection's whole certificate set and takes precedence over idp_certificate

idp_metadata_urlstring nullable

The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them

idp_metadatastring nullable

The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties

organization_idstring nullable

The ID of the organization to which users of this SAML Connection will be added

activeboolean nullable

Activate or de-activate the SAML Connection

sync_user_attributesboolean nullable

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

allow_subdomainsboolean nullable

Allow users with an email address subdomain to use this connection in order to authenticate

allow_idp_initiatedboolean nullable

Enable or deactivate IdP-initiated flows

disable_additional_identificationsboolean nullable

Enable or deactivate additional identifications

allow_organization_account_linkingboolean nullable

Whether this connection supports account linking via organization membership

force_authnboolean

Enable or deactivate ForceAuthn

consent_verified_domains_deletionboolean nullable

When enabling the connection, controls behavior when verified domains used for enrollment modes like automatic invitation or automatic suggestion already exist for the same domain. If true, those verified domains are removed and the connection is enabled. If false or omitted, the request fails when any such verified domain exists.

Response

A SAML Connection

OR

Changes

  • 2025-11-10896a452e4c0cRevision changes
    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      added the required property to the response with the status

  • 2025-11-101d47a6af3befRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status