Skip to main content

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

    Whether the connection is active or not.

  • Name
    allowOrganizationAccountLinking
    Type
    boolean
    Description

    Whether existing users who are members of the organization can link their account to their enterprise identity.

  • Name
    allowSubdomains
    Type
    undefined | boolean
    Description

    Whether users with an email address subdomain are allowed to use this connection or not. Deprecated. The Backend API does not return this field at the top level, so it is always undefined. Use samlConnection.allowSubdomains instead.

  • Name
    authenticatable
    Type
    boolean
    Description

    Whether the connection can be used for sign-in and sign-up.

  • Name
    createdAt
    Type
    number
    Description

    The date when the connection was first created.

  • Name
    customAttributes
    Type
    undefined | EnterpriseConnectionCustomAttribute[]
    Description

    The custom attribute mappings of the connection. Only returned when the custom attributes feature is enabled for the instance.

  • Name
    disableAdditionalIdentifications
    Type
    boolean
    Description

    Whether additional identifications are disabled for this connection.

  • Name
    disableJitProvisioning
    Type
    boolean
    Description

    Whether Just-in-Time (JIT) provisioning of users is disabled for the 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
    logoPublicUrl
    Type
    undefined | string
    Description

    The public URL of the provider logo, if available.

  • 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
    provider
    Type
    string
    Description

    The identity provider (IdP) of the connection. For example, 'saml_custom' or 'oidc_custom'.

  • Name
    samlConnection
    Type
    null | EnterpriseConnectionSamlConnection
    Description

    SAML connection details when the enterprise connection uses SAML.

  • Name
    syncUserAttributes
    Type
    boolean
    Description

    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