oidc-client-ts
    Preparing search index...

    Class User

    Index

    Constructors

    constructor

    Properties

    access_token expires_at? id_token? profile refresh_token? scope? session_state state token_type url_state?

    Accessors

    expired expires_in scopes

    Methods

    toStorageString fromStorageString

    Constructors

    • Parameters

      • args: {
            access_token: string;
            expires_at?: number;
            id_token?: string;
            profile: IdTokenClaims;
            refresh_token?: string;
            scope?: string;
            session_state?: null | string;
            token_type: string;
            url_state?: string;
            userState?: unknown;
        }

      Returns User

    Properties

    access_token: string

    The requested access token returned from the OIDC provider. The application can use this token to authenticate itself to the secured resource.

    expires_at?: number

    The expires at returned from the OIDC provider.

    id_token?: string

    A JSON Web Token (JWT). Only provided if openid scope was requested. The application can access the data decoded by using the profile property.

    profile: IdTokenClaims

    The claims represented by a combination of the id_token and the user info endpoint.

    refresh_token?: string

    An OAuth 2.0 refresh token. The app can use this token to acquire additional access tokens after the current access token expires. Refresh tokens are long-lived and can be used to maintain access to resources for extended periods of time.

    scope?: string

    The scopes that the requested access token is valid for.

    session_state: null | string

    The session state value returned from the OIDC provider.

    state: unknown

    custom state data set during the initial signin request

    token_type: string

    Typically "Bearer"

    url_state?: string

    Accessors

    • get expired(): undefined | boolean

      Computed value indicating if the access token is expired.

      Returns undefined | boolean

    • get expires_in(): undefined | number

      Computed number of seconds the access token has remaining.

      Returns undefined | number

    • set expires_in(value: undefined | number): void

      Parameters

      • value: undefined | number

      Returns void

    • get scopes(): string[]

      Array representing the parsed values from the scope.

      Returns string[]

    Methods

    • Parameters

      • storageString: string

      Returns User

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods