Class SigninState

Hierarchy (View Summary)

State
- SigninState

Index

Properties

authority client_id client_secret code_challenge code_verifier created data? extraTokenParams id redirect_uri request_type response_mode scope skipUserInfo url_state

Methods

toStorageString clearStaleState create fromStorageString

Properties

`Readonly`authority

authority: string

See

OidcClientSettings.authority

`Readonly`client_id

client_id: string

See

OidcClientSettings.client_id

`Readonly`client_secret

client_secret: string | undefined

See

OidcClientSettings.client_secret

`Readonly`code_challenge

code_challenge: string | undefined

Used to secure authorization code grants via Proof Key for Code Exchange (PKCE).

`Readonly`code_verifier

code_verifier: string | undefined

The same code_verifier that was used to obtain the authorization_code via PKCE.

`Readonly`created

created: number

`Optional` `Readonly`data

data?: unknown

custom "state", which can be used by a caller to have "data" round tripped

`Readonly`extraTokenParams

extraTokenParams: Record<string, unknown> | undefined

See

OidcClientSettings.extraTokenParams

`Readonly`id

id: string

`Readonly`redirect_uri

redirect_uri: string

See

OidcClientSettings.redirect_uri

`Readonly`request_type

request_type: string | undefined

`Readonly`response_mode

response_mode: "query" | "fragment" | undefined

See

OidcClientSettings.response_mode

`Readonly`scope

scope: string

See

OidcClientSettings.scope

`Readonly`skipUserInfo

skipUserInfo: boolean | undefined

`Readonly`url_state

url_state: string | undefined

Methods

toStorageString

toStorageString(): string
Returns string
Overrides State.toStorageString
- Defined in src/SigninState.ts:87

`Static`clearStaleState

clearStaleState(storage: StateStore, age: number): Promise<void>
Parameters
- storage: StateStore
- age: number
Returns Promise<void>
Inherited from State.clearStaleState
- Defined in src/State.ts:55

`Static`create

create(args: SigninStateCreateArgs): Promise<SigninState>
Parameters
- args: SigninStateCreateArgs
Returns Promise<SigninState>
- Defined in src/SigninState.ts:76

`Static`fromStorageString

fromStorageString(storageString: string): Promise<SigninState>
Parameters
- storageString: string
Returns Promise<SigninState>
Overrides State.fromStorageString
- Defined in src/SigninState.ts:108

Class SigninState

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlyauthority

See

Readonlyclient_id

See

Readonlyclient_secret

See

Readonlycode_challenge

Readonlycode_verifier

Readonlycreated

Optional Readonlydata

ReadonlyextraTokenParams

See

Readonlyid

Readonlyredirect_uri

See

Readonlyrequest_type

Readonlyresponse_mode

See

Readonlyscope

See

ReadonlyskipUserInfo

Readonlyurl_state

Methods

toStorageString

Returns string

StaticclearStaleState

Parameters

Returns Promise<void>

Staticcreate

Parameters

Returns Promise<SigninState>

StaticfromStorageString

Parameters

Returns Promise<SigninState>

Settings

On This Page

`Readonly`authority

`Readonly`client_id

`Readonly`client_secret

`Readonly`code_challenge

`Readonly`code_verifier

`Readonly`created

`Optional` `Readonly`data

`Readonly`extraTokenParams

`Readonly`id

`Readonly`redirect_uri

`Readonly`request_type

`Readonly`response_mode

`Readonly`scope

`Readonly`skipUserInfo

`Readonly`url_state

`Static`clearStaleState

`Static`create

`Static`fromStorageString