Skip to main content

The Backend ExternalAccount object

The Backend ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).

External account must be verified, so that you can make sure they can be assigned to their rightful owners. The ExternalAccount object holds all necessary state around the verification process.

Properties

  • Name
    approvedScopes
    Type
    string
    Description

    The scopes that the user has granted access to.

  • Name
    emailAddress
    Type
    string
    Description

    The user's email address.

  • Name
    externalAccountId?
    Type
    string
    Description

    The eac_-prefixed id of the external account resource, which is the id users.deleteUserExternalAccount() expects. Only returned for Google and Facebook accounts; for other providers it is undefined and id already holds the eac_ value. Use externalAccountId ?? id to get a deletable id.

  • Name
    externalId
    Type
    string
    Description

    Deprecated. Use identificationId instead.

  • Name
    firstName
    Type
    string
    Description

    The user's first name.

  • Name
    id
    Type
    string
    Description

    The unique identifier for this external account.

  • Name
    identificationId
    Type
    string
    Description

    The identification with which this external account is associated.

  • Name
    imageUrl
    Type
    string
    Description

    The user's image URL.

  • Name
    label
    Type
    null | string
    Description

    A descriptive label to differentiate multiple external accounts of the same user for the same provider.

  • Name
    lastName
    Type
    string
    Description

    The user's last name.

  • Name
    phoneNumber
    Type
    null | string
    Description

    The phone number related to this specific external account.

  • Name
    provider
    Type
    string
    Description

    The provider name (e.g., google).

  • Name
    providerUserId
    Type
    string
    Description

    The unique ID of the user in the provider.

  • Name
    publicMetadata
    Type
    null | 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
    username
    Type
    null | string
    Description

    The user's username.

  • Name
    verification
    Type
    null | Verification
    Description

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub