Class OpenIdConnectManager

Hierarchy (View Summary)

AbstractConnectManager
- OpenIdConnectManager

Index

Constructors

Properties

configManager stateManager

Accessors

codeVerifier currentState redirectUrl state

Methods

handleExternalLogout initialize isNullOrUndefined isNullOrUndefinedOrBlank login logout logoutFromIssuer setToken silentLogin getInstance

Constructors

constructor

new OpenIdConnectManager(type: string): OpenIdConnectManager
Parameters
- type: string
Returns OpenIdConnectManager
Inherited from AbstractConnectManager.constructor
- Defined in src/tools/auth/abstractconnectmanager.ts:13

Properties

`Protected` `Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`stateManager

stateManager: StateManager

Accessors

codeVerifier

get codeVerifier(): string
Code verifier for Authorization Code Grant with Proof Key for Code Exchange (PKCE) It has to be the same when coming back from the issuer after a redirect Therefore, we keep it in localStorage.

Returns string
- Defined in src/tools/auth/openidconnectmanager.ts:60
set codeVerifier(value: string): void
Parameters
- value: string
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:64

currentState

get currentState(): string
The currentState cannot just be passed as parameter in the URL Because the URL-length is limited. Therefore, we keep it in localStorage.

Returns string
- Defined in src/tools/auth/openidconnectmanager.ts:86
set currentState(value: string): void
Parameters
- value: string
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:90

redirectUrl

get redirectUrl(): string
The RedirectUrl has to be the same for all call to the issuer Because the authentication is given for a specific redirectUrl. Therefore, we keep it in localStorage.

Returns string
- Defined in src/tools/auth/openidconnectmanager.ts:73
set redirectUrl(value: string): void
Parameters
- value: string
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:77

state

get state(): State
Returns State
Inherited from AbstractConnectManager.state
- Defined in src/tools/auth/abstractconnectmanager.ts:9

Methods

handleExternalLogout

handleExternalLogout(): void
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:307

initialize

initialize(): void
Returns void
Overrides AbstractConnectManager.initialize
- Defined in src/tools/auth/openidconnectmanager.ts:42

isNullOrUndefined

isNullOrUndefined(val: unknown): val is undefined | null
Parameters
- val: unknown
Returns val is undefined | null
Inherited from AbstractConnectManager.isNullOrUndefined
- Defined in src/base/GirafeSingleton.ts:41

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): val is undefined | null | ""
Parameters
- val: unknown
Returns val is undefined | null | ""
Inherited from AbstractConnectManager.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeSingleton.ts:45

login(): Promise<void>
Returns Promise<void>
Overrides AbstractConnectManager.login
- Defined in src/tools/auth/openidconnectmanager.ts:122

logout

logout(): Promise<void>
Returns Promise<void>
Overrides AbstractConnectManager.logout
- Defined in src/tools/auth/openidconnectmanager.ts:145

logoutFromIssuer

logoutFromIssuer(): Promise<void>
Returns Promise<void>
- Defined in src/tools/auth/openidconnectmanager.ts:291

setToken

setToken(tokens: TokenEndpointResponse): void
Parameters
- tokens: TokenEndpointResponse
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:227

silentLogin

silentLogin(): Promise<void>
Returns Promise<void>
Overrides AbstractConnectManager.silentLogin
- Defined in src/tools/auth/openidconnectmanager.ts:134

`Static`getInstance

getInstance<T>(this: Constructor<T>): T
Type Parameters
- T
Parameters
- this: Constructor<T>
Returns T
Inherited from AbstractConnectManager.getInstance
- Defined in src/base/GirafeSingleton.ts:23