Docs

The Backend SamlConnection object

The Backend SamlConnection object holds information about a SAML connection for an organization.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the connection.

  • Name
    acsUrl
    Type
    string
    Description

    The Assertion Consumer Service (ACS) URL of the connection.

  • Name
    active
    Type
    boolean
    Description

    Indicates whether the connection is active or not.

  • Name
    allowIdpInitiated
    Type
    boolean
    Description

    Indicates whether the connection allows Identity Provider (IdP) initiated flows or not.

  • Name
    allowSubdomains
    Type
    boolean
    Description

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

  • Name
    attributeMapping
    Type
    { userId: string, emailAddress: string, firstName: string, lastName: string }
    Description

    Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's User properties.

  • Name
    createdAt
    Type
    number
    Description

    The date when the connection was first created.

  • Name
    domain
    Type
    string
    Description

    The domain of your organization. Sign in flows using an email with this domain will use the connection.

  • Name
    idpEntityId
    Type
    string
    Description

    The Entity ID as provided by the Identity Provider (IdP)

  • Name
    idpSsoUrl
    Type
    string
    Description

    The Single-Sign On URL as provided by the Identity Provider (IdP).

  • Name
    idpCertificate
    Type
    string
    Description

    The X.509 certificate as provided by the Identity Provider (IdP)

  • Name
    idpMetadataUrl
    Type
    string
    Description

    The URL which serves the Identity Provider (IdP) metadata. If present, it takes priority over the corresponding individual properties.

  • Name
    idpMetadata
    Type
    string
    Description

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

  • Name
    name
    Type
    string
    Description

    The name to use as a label for the connection.

  • Name
    spEntityId
    Type
    string
    Description

    The Entity ID as provided by the Service Provider (Clerk).

  • Name
    spMetadataUrl
    Type
    string
    Description

    The metadata URL as provided by the Service Provider (Clerk).

  • Name
    provider
    Type
    string
    Description

    The Identity Provider (IdP) of the connection.

  • Name
    syncUserAttributes
    Type
    boolean
    Description

    Indicates whether the connection syncs user attributes between the Service Provider (SP) and Identity Provider (IdP) or not.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the SAML connection was last updated.

  • Name
    userCount
    Type
    number
    Description

    The number of users associated with the connection.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on