Class SigninState

Hierarchy (view full)

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: undefined | string

See

OidcClientSettings.client_secret

`Readonly` code_challenge

code_challenge: undefined | string

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

`Readonly` code_verifier

code_verifier: undefined | string

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: undefined | Record<string, unknown>

See

OidcClientSettings.extraTokenParams

`Readonly` id

id: string

`Readonly` redirect_uri

redirect_uri: string

See

OidcClientSettings.redirect_uri

`Readonly` request_type

request_type: undefined | string

`Readonly` response_mode

response_mode: undefined | "query" | "fragment"

See

OidcClientSettings.response_mode

`Readonly` scope

scope: string

See

OidcClientSettings.scope

`Readonly` skipUserInfo

skipUserInfo: undefined | boolean

`Readonly` url_state

url_state: undefined | string

Methods

toStorageString

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

`Static` clearStaleState

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

`Static` create

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

`Static` fromStorageString

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

Class SigninState

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly authority

See

Readonly client_id

See

Readonly client_secret

See

Readonly code_challenge

Readonly code_verifier

Readonly created

Optional Readonly data

Readonly extraTokenParams

See

Readonly id

Readonly redirect_uri

See

Readonly request_type

Readonly response_mode

See

Readonly scope

See

Readonly skipUserInfo

Readonly url_state

Methods

toStorageString

Returns string

Static clearStaleState

Parameters

storage: StateStore

age: number

Returns Promise<void>

Static create

Parameters

args: SigninStateCreateArgs

Returns Promise<SigninState>

Static fromStorageString

Parameters

storageString: string

Returns Promise<SigninState>

Settings

Member Visibility

Theme

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