Skip to main content
Docs

The Backend EnterpriseAccount object

The Backend EnterpriseAccount object represents an identification obtained via enterprise SSO (SAML or OIDC).

Properties

  • Name
    active
    Type
    boolean
    Description

    Whether this enterprise account is currently active.

  • Name
    emailAddress
    Type
    string
    Description

    The email address associated with this enterprise account.

  • Name
    enterpriseConnection
    Type
    null | EnterpriseAccountConnection
    Description

    The enterprise connection through which this account was authenticated.

  • Name
    enterpriseConnectionId
    Type
    null | string
    Description

    The ID of the enterprise connection associated with this account.

  • Name
    firstName
    Type
    null | string
    Description

    The user's first name as provided by the IdP.

  • Name
    id
    Type
    string
    Description

    The unique identifier for this enterprise account.

  • Name
    lastAuthenticatedAt
    Type
    null | number
    Description

    The date when the user last authenticated via this enterprise account.

  • Name
    lastName
    Type
    null | string
    Description

    The user's last name as provided by the IdP.

  • Name
    protocol
    Type
    string
    Description

    The SSO protocol used (e.g., saml or oauth).

  • Name
    provider
    Type
    string
    Description

    The SSO provider (e.g., saml_custom, saml_okta).

  • Name
    providerUserId
    Type
    null | string
    Description

    The unique ID of the user in the provider.

  • Name
    publicMetadata
    Type
    Record<string, unknown>
    Description

    Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.

  • Name
    verification
    Type
    null | Verification
    Description

    An object holding information on the verification of this enterprise account.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub