@faable/auth-js - v1.7.4
    Preparing search index...

    Interface Session

    A signed-in session as persisted by the client.

    Use FaableAuthClient.getSession to obtain the current value; the SDK refreshes it automatically before expires_at.

    UserInfo

    interface Session {
        access_token: string;
        expires_at?: number;
        expires_in: number;
        provider_refresh_token?: string | null;
        provider_token?: string | null;
        refresh_token: string;
        token_type: string;
        user: User;
    }
    Index

    Properties

    access_token expires_at? expires_in provider_refresh_token? provider_token? refresh_token token_type user

    Properties

    access_token: string

    The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.

    expires_at?: number

    A timestamp of when the token will expire. Returned when a login is confirmed.

    expires_in: number

    The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.

    provider_refresh_token?: string | null

    The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.

    provider_token?: string | null

    The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.

    refresh_token: string

    A one-time used refresh token that never expires.

    token_type: string
    user: User

    Settings

    Member Visibility

    On This Page

    Properties