Interface AuthenticationSession

Represents a session of a currently logged in user.

interface AuthenticationSession {
    accessToken: string;
    account: AuthenticationSessionAccountInformation;
    id: string;
    idToken?: string;
    scopes: readonly string[];
}

Hierarchy (View Summary)

AuthenticationSession
- AuthenticationSession

Index

Properties

accessToken account id idToken? scopes

Properties

`Readonly`accessToken

accessToken: string

The access token. This token should be used to authenticate requests to a service. Popularized by OAuth.

Reference

https://oauth.net/2/access-tokens/

`Readonly`account

account: AuthenticationSessionAccountInformation

The account associated with the session.

`Readonly`id

id: string

The identifier of the authentication session.

`Optional` `Readonly`idToken

idToken?: string

The ID token. This token contains identity information about the user. Popularized by OpenID Connect.

Reference

https://openid.net/specs/openid-connect-core-1_0.html#IDToken

`Readonly`scopes

scopes: readonly string[]

The permissions granted by the session's access token. Available scopes are defined by the AuthenticationProvider.

Interface AuthenticationSession

Hierarchy (View Summary)

Index

Properties

Properties

`Readonly`accessToken

Reference

`Readonly`account

`Readonly`id

`Optional` `Readonly`idToken

Reference

`Readonly`scopes

Settings

On This Page

Interface AuthenticationSession

Hierarchy (View Summary)

Index

Properties

Properties

ReadonlyaccessToken

Reference

Readonlyaccount

Readonlyid

Optional ReadonlyidToken

Reference

Readonlyscopes

Settings

On This Page

`Readonly`accessToken

`Readonly`account

`Readonly`id

`Optional` `Readonly`idToken

`Readonly`scopes