index.usermanager.md

oidc-react / index / UserManager

Class: UserManager

index.UserManager

Hierarchy

• OidcClient

  ↳ UserManager

Table of contents

Constructors

• constructor

Properties

• events
• metadataService
• settings

Methods

• clearStaleState
• createSigninRequest
• createSignoutRequest
• getUser
• processSigninResponse
• processSignoutResponse
• querySessionStatus
• removeUser
• revokeAccessToken
• signinCallback
• signinPopup
• signinPopupCallback
• signinRedirect
• signinRedirectCallback
• signinSilent
• signinSilentCallback
• signoutCallback
• signoutPopup
• signoutPopupCallback
• signoutRedirect
• signoutRedirectCallback
• startSilentRenew
• stopSilentRenew
• storeUser

Constructors

constructor

+ new UserManager(settings: UserManagerSettings): UserManager

Parameters:

Name	Type
settings	UserManagerSettings

Returns: UserManager

Overrides: OidcClient.constructor

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

Properties

events

• events: UserManagerEvents

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

---

metadataService

• Readonly metadataService: MetadataService

Inherited from: OidcClient.metadataService

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

---

settings

• Readonly settings: UserManagerSettings

Overrides: OidcClient.settings

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

Methods

clearStaleState

▸ clearStaleState(): Promise<void>

Removes stale state entries in storage for incomplete authorize requests

Returns: Promise<void>

Overrides: OidcClient.clearStaleState

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

---

createSigninRequest

▸ createSigninRequest(args?: any): Promise<SigninRequest>

Parameters:

Name	Type
args?	any

Returns: Promise<SigninRequest>

Inherited from: OidcClient.createSigninRequest

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

---

createSignoutRequest

▸ createSignoutRequest(args?: any): Promise<SignoutRequest>

Parameters:

Name	Type
args?	any

Returns: Promise<SignoutRequest>

Inherited from: OidcClient.createSignoutRequest

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

---

getUser

▸ getUser(): Promise<null | User>

Load the User object for the currently authenticated user

Returns: Promise<null | User>

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

---

processSigninResponse

▸ processSigninResponse(url?: string, stateStore?: StateStore): Promise<SigninResponse>

Parameters:

Name	Type
url?	string
stateStore?	StateStore

Returns: Promise<SigninResponse>

Inherited from: OidcClient.processSigninResponse

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

---

processSignoutResponse

▸ processSignoutResponse(url?: string, stateStore?: StateStore): Promise<SignoutResponse>

Parameters:

Name	Type
url?	string
stateStore?	StateStore

Returns: Promise<SignoutResponse>

Inherited from: OidcClient.processSignoutResponse

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

---

querySessionStatus

▸ querySessionStatus(args?: any): Promise<SessionStatus>

Query OP for user's current signin status

Parameters:

Name	Type
args?	any

Returns: Promise<SessionStatus>

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

---

removeUser

▸ removeUser(): Promise<void>

Remove from any storage the currently authenticated user

Returns: Promise<void>

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

---

revokeAccessToken

▸ revokeAccessToken(): Promise<void>

Returns: Promise<void>

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

---

signinCallback

▸ signinCallback(url?: string): Promise<User>

Proxy to Popup, Redirect and Silent callbacks

Parameters:

Name	Type
url?	string

Returns: Promise<User>

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

---

signinPopup

▸ signinPopup(args?: any): Promise<User>

Trigger a request (via a popup window) to the authorization endpoint. The result of the promise is the authenticated User

Parameters:

Name	Type
args?	any

Returns: Promise<User>

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

---

signinPopupCallback

▸ signinPopupCallback(url?: string): Promise<undefined | User>

Notify the opening window of response from the authorization endpoint

Parameters:

Name	Type
url?	string

Returns: Promise<undefined | User>

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

---

signinRedirect

▸ signinRedirect(args?: any): Promise<void>

Trigger a redirect of the current window to the authorization endpoint

Parameters:

Name	Type
args?	any

Returns: Promise<void>

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

---

signinRedirectCallback

▸ signinRedirectCallback(url?: string): Promise<User>

Process response from the authorization endpoint.

Parameters:

Name	Type
url?	string

Returns: Promise<User>

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

---

signinSilent

▸ signinSilent(args?: any): Promise<User>

Trigger a silent request (via an iframe or refreshtoken if available) to the authorization endpoint

Parameters:

Name	Type
args?	any

Returns: Promise<User>

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

---

signinSilentCallback

▸ signinSilentCallback(url?: string): Promise<undefined | User>

Notify the parent window of response from the authorization endpoint

Parameters:

Name	Type
url?	string

Returns: Promise<undefined | User>

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

---

signoutCallback

▸ signoutCallback(url?: string, keepWindowOpen?: boolean): Promise<undefined | SignoutResponse>

Proxy to Popup and Redirect callbacks

Parameters:

Name	Type
url?	string
keepWindowOpen?	boolean

Returns: Promise<undefined | SignoutResponse>

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

---

signoutPopup

▸ signoutPopup(args?: any): Promise<void>

Trigger a redirect of a popup window window to the end session endpoint

Parameters:

Name	Type
args?	any

Returns: Promise<void>

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

---

signoutPopupCallback

▸ signoutPopupCallback(url?: string, keepOpen?: boolean): Promise<void>

Process response from the end session endpoint from a popup window

Parameters:

Name	Type
url?	string
keepOpen?	boolean

Returns: Promise<void>

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

▸ signoutPopupCallback(keepOpen?: boolean): Promise<void>

Parameters:

Name	Type
keepOpen?	boolean

Returns: Promise<void>

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

---

signoutRedirect

▸ signoutRedirect(args?: any): Promise<void>

Trigger a redirect of the current window to the end session endpoint

Parameters:

Name	Type
args?	any

Returns: Promise<void>

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

---

signoutRedirectCallback

▸ signoutRedirectCallback(url?: string): Promise<SignoutResponse>

Process response from the end session endpoint

Parameters:

Name	Type
url?	string

Returns: Promise<SignoutResponse>

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

---

startSilentRenew

▸ startSilentRenew(): void

Enables silent renew

Returns: void

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

---

stopSilentRenew

▸ stopSilentRenew(): void

Disables silent renew

Returns: void

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

---

storeUser

▸ storeUser(user: User): Promise<void>

Parameters:

Name	Type
user	User

Returns: Promise<void>

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