index.user.md

oidc-react / index / User

Class: User

index.User

Table of contents

Constructors

• constructor

Properties

• access_token
• expired
• expires_at
• expires_in
• id_token
• profile
• refresh_token
• scope
• scopes
• session_state
• state
• token_type

Methods

• toStorageString
• fromStorageString

Constructors

constructor

+ new User(settings: UserSettings): User

Parameters:

Name	Type
settings	UserSettings

Returns: User

Defined in: node_modules/oidc-client/index.d.ts:388

Properties

access_token

• access_token: string

The access token returned from the OIDC provider.

Defined in: node_modules/oidc-client/index.d.ts:396

---

expired

• Readonly expired: boolean

Calculated value indicating if the access token is expired

Defined in: node_modules/oidc-client/index.d.ts:416

---

expires_at

• expires_at: number

The expires at returned from the OIDC provider

Defined in: node_modules/oidc-client/index.d.ts:406

---

expires_in

• Readonly expires_in: number

Calculated number of seconds the access token has remaining

Defined in: node_modules/oidc-client/index.d.ts:414

---

id_token

• id_token: string

The id_token returned from the OIDC provider

Defined in: node_modules/oidc-client/index.d.ts:392

---

profile

• profile: Profile

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

Defined in: node_modules/oidc-client/index.d.ts:404

---

refresh_token

• Optional refresh_token: string

Refresh token returned from the OIDC provider (if requested)

Defined in: node_modules/oidc-client/index.d.ts:398

---

scope

• scope: string

The scope returned from the OIDC provider

Defined in: node_modules/oidc-client/index.d.ts:402

---

scopes

• Readonly scopes: string[]

Array representing the parsed values from the scope

Defined in: node_modules/oidc-client/index.d.ts:418

---

session_state

• Optional session_state: string

The session state value returned from the OIDC provider (opaque)

Defined in: node_modules/oidc-client/index.d.ts:394

---

state

• state: any

The custom state transferred in the last signin

Defined in: node_modules/oidc-client/index.d.ts:408

---

token_type

• token_type: string

The token_type returned from the OIDC provider

Defined in: node_modules/oidc-client/index.d.ts:400

Methods

toStorageString

▸ toStorageString(): string

Returns: string

Defined in: node_modules/oidc-client/index.d.ts:410

---

fromStorageString

▸ StaticfromStorageString(storageString: string): User

Parameters:

Name	Type
storageString	string

Returns: User

Defined in: node_modules/oidc-client/index.d.ts:411