Class AuthenticationProvider

Authentication provider implementation consumed by the Gestalt runtime.

Hierarchy (View Summary)

RuntimeProvider
- AuthenticationProvider

Constructors

constructor

new AuthenticationProvider(
options: AuthenticationProviderOptions,
): AuthenticationProvider
Parameters
- options: AuthenticationProviderOptions
Returns AuthenticationProvider
Overrides RuntimeProvider.constructor
- Defined in ../../src/auth.ts:79

Properties

`Readonly`kind

kind: "authentication" = ...

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

Methods

beginLogin

beginLogin(request: BeginLoginRequest): Promise<BeginLoginResponse>
Parameters
- request: BeginLoginRequest
Returns Promise<BeginLoginResponse>
- Defined in ../../src/auth.ts:87

completeLogin

completeLogin(request: CompleteLoginRequest): Promise<AuthenticatedUser>
Parameters
- request: CompleteLoginRequest
Returns Promise<AuthenticatedUser>
- Defined in ../../src/auth.ts:91

supportsExternalTokenValidation

supportsExternalTokenValidation(): boolean
Returns boolean
- Defined in ../../src/auth.ts:95

validateExternalToken

validateExternalToken(
token: string,
): Promise<AuthenticatedUser | null | undefined>
Parameters
- token: string
Returns Promise<AuthenticatedUser | null | undefined>
- Defined in ../../src/auth.ts:99

supportsSessionSettings

supportsSessionSettings(): boolean
Returns boolean
- Defined in ../../src/auth.ts:103

sessionSettings

sessionSettings(): Promise<AuthenticationSessionSettings | undefined>
Returns Promise<AuthenticationSessionSettings | undefined>
- Defined in ../../src/auth.ts:107

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from RuntimeProvider.resolveName
- Defined in ../../src/provider.ts:102

runtimeMetadata

runtimeMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from RuntimeProvider.runtimeMetadata
- Defined in ../../src/provider.ts:108

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from RuntimeProvider.configureProvider
- Defined in ../../src/provider.ts:127

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from RuntimeProvider.supportsHealthCheck
- Defined in ../../src/provider.ts:131

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.healthCheck
- Defined in ../../src/provider.ts:135

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.startProvider
- Defined in ../../src/provider.ts:139

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from RuntimeProvider.warnings
- Defined in ../../src/provider.ts:143

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.closeProvider
- Defined in ../../src/provider.ts:153