Class OpenIdConnectManager

Hierarchy (View Summary)

AbstractConnectManager
- OpenIdConnectManager

Constructors

constructor

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

Properties

`Protected` `Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`sessionManager

sessionManager: SessionManager

`Protected` `Readonly`stateManager

stateManager: StateManager

`Protected` `Readonly`urlManager

urlManager: UrlManager

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:72
set codeVerifier(value: string): void
Parameters
- value: string
Returns void
- Defined in src/tools/auth/openidconnectmanager.ts:76

`Protected`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
Inherited from GMFConnectManager.redirectUrl
- Defined in src/tools/auth/abstractconnectmanager.ts:67
set redirectUrl(value: string): void
Parameters
- value: string
Returns void
Inherited from GMFConnectManager.redirectUrl
- Defined in src/tools/auth/abstractconnectmanager.ts:71

`Protected`state

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

Methods

finalizeLoginWorkflow

finalizeLoginWorkflow(): void
Returns void
Inherited from AbstractConnectManager.finalizeLoginWorkflow
- Defined in src/tools/auth/abstractconnectmanager.ts:110

`Protected`getLoginRedirectUrl

getLoginRedirectUrl(silent: boolean): string
Parameters
- silent: boolean
Returns string
Inherited from AbstractConnectManager.getLoginRedirectUrl
- Defined in src/tools/auth/abstractconnectmanager.ts:75

`Protected`getLogoutRedirectUrl

getLogoutRedirectUrl(): string
Returns string
Inherited from AbstractConnectManager.getLogoutRedirectUrl
- Defined in src/tools/auth/abstractconnectmanager.ts:89

handleErrorFromIssuer

handleErrorFromIssuer(): void
Returns void
Inherited from AbstractConnectManager.handleErrorFromIssuer
- Defined in src/tools/auth/abstractconnectmanager.ts:45

handleUnknownError

handleUnknownError(error: Error): void
Parameters
- error: Error
Returns void
Inherited from AbstractConnectManager.handleUnknownError
- Defined in src/tools/auth/abstractconnectmanager.ts:50

initialize

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

isNullOrUndefined

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

isNullOrUndefinedOrBlank

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

`Protected`loadFromLocalStorage

loadFromLocalStorage(path: string): unknown
Parameters
- path: string
Returns unknown
Inherited from AbstractConnectManager.loadFromLocalStorage
- Defined in src/tools/auth/abstractconnectmanager.ts:96

logoutFromIssuer

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

`Protected`resetUrl

resetUrl(): void
Returns void
Inherited from AbstractConnectManager.resetUrl
- Defined in src/tools/auth/abstractconnectmanager.ts:104

`Protected`saveToLocalStorage

saveToLocalStorage(path: string, value: string): void
Parameters
- path: string
- value: string
Returns void
Inherited from AbstractConnectManager.saveToLocalStorage
- Defined in src/tools/auth/abstractconnectmanager.ts:100

silentLogin

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

`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

Class OpenIdConnectManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OpenIdConnectManager

Properties

Protected ReadonlyconfigManager

Protected ReadonlysessionManager

Protected ReadonlystateManager

Protected ReadonlyurlManager

Accessors

codeVerifier

Returns string

Parameters

Returns void

ProtectedredirectUrl

Returns string

Parameters

Returns void

Protectedstate

Returns State

Methods

finalizeLoginWorkflow

Returns void

ProtectedgetLoginRedirectUrl

Parameters

Returns string

ProtectedgetLogoutRedirectUrl

Returns string

handleErrorFromIssuer

Returns void

handleUnknownError

Parameters

Returns void

initialize

Returns Promise<void>

isNullOrUndefined

Parameters

Returns val is null | undefined

isNullOrUndefinedOrBlank

Parameters

Returns val is "" | null | undefined

ProtectedloadFromLocalStorage

Parameters

Returns unknown

ProtectedloggedOut

Returns void

ProtectedloggedOutFromBackend

Returns void

login

Returns Promise<void>

logout

Returns Promise<void>

logoutFromIssuer

Returns Promise<void>

ProtectedresetUrl

Returns void

ProtectedsaveToLocalStorage

Parameters

Returns void

silentLogin

Returns Promise<void>

StaticgetInstance

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected` `Readonly`configManager

`Protected` `Readonly`sessionManager

`Protected` `Readonly`stateManager

`Protected` `Readonly`urlManager

`Protected`redirectUrl

`Protected`state

`Protected`getLoginRedirectUrl

`Protected`getLogoutRedirectUrl

`Protected`loadFromLocalStorage

`Protected`loggedOut

`Protected`loggedOutFromBackend

`Protected`resetUrl

`Protected`saveToLocalStorage

`Static`getInstance