Sign in
Enterprise Connections

Update an enterprise connection

Updates the enterprise connection whose ID matches the provided enterprise_connection_id in the path. When enabling the connection (setting active to true), any existing verified organization domains that match the connection's domains (e.g. used for enrollment modes like automatic invitation) may be deleted so the connection can be enabled.

patch/enterprise_connections/{enterprise_connection_id}

Path parameters

enterprise_connection_idstring required

The ID of the enterprise connection to update

Request body

namestring nullable

The display name of the enterprise connection

domainsstring[] nullable

Domains associated with the enterprise connection. Values are normalized to lowercase. Empty array means ignored (no change); non-empty array means set domains to the given list (replaces existing).

activeboolean nullable

Whether the enterprise connection is active. When set to true (enabling), any existing verified organization domains for the same domain(s) will be removed so the connection can be enabled.

sync_user_attributesboolean nullable

Whether to sync user attributes on sign-in

disable_additional_identificationsboolean nullable

Whether to disable additional identifications

allow_organization_account_linkingboolean nullable

Whether this connection supports account linking via organization membership

organization_idstring nullable

Organization ID to link to this enterprise connection. Only linking is supported; sending this field sets or changes the linked organization. There is no way to unlink an organization once linked.

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

Changed in 3 of the 15 revisions of this API.7

  • 7d969765e49a2See the full diff
    • ○

      added the new optional request property custom_attributes/items/directory_path

      new-optional-request-property

    • ○

      added the optional property custom_attributes/items/directory_path to the response with the 200 status

      response-optional-property-added

  • 405105aa16c33See the full diff
    • ○

      added the new optional request property saml/login_hint

      new-optional-request-property

    • ○

      added the optional property saml_connection/login_hint to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property object to the response with the 200 status

      response-required-property-added

  • 661534a68b4f2See the full diff
    • ○

      added the new optional request property custom_attributes/items/multi_valued

      new-optional-request-property

    • ○

      added the optional property custom_attributes/items/multi_valued to the response with the 200 status

      response-optional-property-added