Skip to main content

The Backend EnterpriseConnectionSamlConnection object

The Backend EnterpriseConnectionSamlConnection object holds information about a SAML enterprise connection for an instance or organization.

Properties

  • Name
    acsUrl
    Type
    undefined | string
    Description

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

  • Name
    active
    Type
    boolean
    Description

    Whether the SAML connection is active.

  • Name
    allowIdpInitiated
    Type
    boolean
    Description

    Whether IdP-initiated SSO is allowed.

  • Name
    allowSubdomains
    Type
    boolean
    Description

    Whether users with an email address subdomain are allowed to use this connection.

  • Name
    forceAuthn
    Type
    boolean
    Description

    Whether the SAML connection requires force authentication.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the SAML connection.

  • Name
    idpCertificate
    Type
    undefined | string
    Description

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

  • Name
    idpCertificateExpiresAt
    Type
    undefined | number
    Description

    The Unix timestamp when the Identity Provider (IdP) certificate expires.

  • Name
    idpCertificateIssuedAt
    Type
    undefined | number
    Description

    The Unix timestamp when the Identity Provider (IdP) certificate was issued.

  • Name
    idpCertificates
    Type
    SamlConnectionIdpCertificate[]
    Description

    Every Identity Provider (IdP) signing certificate the connection trusts. The first entry is the primary, also returned as idpCertificate.

  • Name
    idpEntityId
    Type
    undefined | string
    Description

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

  • Name
    idpMetadata
    Type
    undefined | string
    Description

    The XML content of the Identity Provider (IdP) metadata file. Deprecated. The Backend API does not return this field, so it is always undefined.

  • Name
    idpMetadataUrl
    Type
    undefined | string
    Description

    The URL which serves the Identity Provider (IdP) metadata.

  • Name
    idpSsoUrl
    Type
    undefined | string
    Description

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

  • Name
    loginHint
    Type
    EnterpriseConnectionSamlConnectionLoginHint
    Description

    The login_hint configuration of the SAML connection.

  • Name
    name
    Type
    string
    Description

    The name to use as a label for the connection.

  • Name
    spEntityId
    Type
    undefined | string
    Description

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

  • Name
    spMetadataUrl
    Type
    undefined | string
    Description

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

  • Name
    syncUserAttributes
    Type
    undefined | boolean
    Description

    Whether the connection syncs user attributes between the IdP and Clerk. Deprecated. The Backend API does not return this field on the nested SAML connection, so it is always undefined. Use the top-level syncUserAttributes on EnterpriseConnection instead.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub