Skip to main content
Docs

The Backend EnterpriseConnection object

The Backend EnterpriseConnection object holds information about an enterprise connection (SAML or OAuth) for an instance or organization.

Properties

  • Name
    active
    Type
    boolean
    Description

    Indicates whether the connection is active or not.

  • Name
    allowSubdomains
    Type
    boolean
    Description

    Indicates whether users with an email address subdomain are allowed to use this connection or not.

  • Name
    createdAt
    Type
    number
    Description

    The date when the connection was first created.

  • Name
    disableAdditionalIdentifications
    Type
    boolean
    Description

    Indicates whether additional identifications are disabled for this connection.

  • Name
    domains
    Type
    string[]
    Description

    The domain of the enterprise. Sign-in flows using an email with this domain may use the connection.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the connection.

  • Name
    name
    Type
    string
    Description

    The name to use as a label for the connection.

  • Name
    oauthConfig
    Type
    null | EnterpriseConnectionOauthConfig
    Description

    OAuth (OIDC) configuration when the enterprise connection uses OAuth.

  • Name
    organizationId
    Type
    null | string
    Description

    The Organization ID if the connection is scoped to an organization.

  • Name
    samlConnection
    Type
    null | EnterpriseConnectionSamlConnection
    Description

    SAML connection details when the enterprise connection uses SAML.

  • Name
    syncUserAttributes
    Type
    boolean
    Description

    Indicates whether the connection syncs user attributes between the IdP and Clerk or not.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the connection was last updated.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub