Skip to main content
Docs

The Backend OauthAccessToken object

The Backend OauthAccessToken object holds information about an OAuth access token associated with a user that has previously authenticated with a particular OAuth provider.

Properties

  • Name
    expiresAt?
    Type
    number
    Description

    The date when the access token expires.

  • Name
    externalAccountId
    Type
    string
    Description

    The ID of the external account associated with this token.

  • Name
    idToken?
    Type
    string
    Description

    The user's OIDC ID Token, if available. This token contains user identity information as a JWT and is returned when the provider supports OpenID Connect (OIDC). Not all OAuth providers implement OIDC, so this field may be undefined for some providers.

  • Name
    label
    Type
    string
    Description

    A descriptive label to differentiate multiple access tokens of the same user for the same provider.

  • Name
    provider
    Type
    string
    Description

    The OAuth provider (e.g., google, github).

  • 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
    scopes?
    Type
    string[]
    Description

    The scopes granted for this access token.

  • Name
    token
    Type
    string
    Description

    The OAuth access token.

  • Name
    tokenSecret?
    Type
    string
    Description

    The token secret, if applicable (e.g., for OAuth 1.0 providers).

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub