Class AuthenticationProvider

Authentication provider implementation consumed by the Gestalt runtime.

Hierarchy (View Summary)

ProviderBase
- AuthenticationProvider

Index

Constructors

constructor

new AuthenticationProvider(
options: AuthenticationProviderOptions,
): AuthenticationProvider
Parameters
- options: AuthenticationProviderOptions
Returns AuthenticationProvider
Overrides ProviderBase.constructor

Properties

`Readonly`kind

kind: "authentication" = ...

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

Methods

authorize

authorize(request: AuthorizeRequest): Promise<AuthorizeResponse>
Parameters
- request: AuthorizeRequest
Returns Promise<AuthorizeResponse>

token

token(request: TokenRequest): Promise<TokenResponse>
Parameters
- request: TokenRequest
Returns Promise<TokenResponse>

introspect

introspect(request: IntrospectRequest): Promise<IntrospectResponse>
Parameters
- request: IntrospectRequest
Returns Promise<IntrospectResponse>

listGrants

listGrants(
request: Record<string, never>,
call: AuthCallContext,
): Promise<{ grantIds: string[] }>
Parameters
- request: Record<string, never>
- call: AuthCallContext
Returns Promise<{ grantIds: string[] }>

getGrant

getGrant(
request: { grantId: string },
call: AuthCallContext,
): Promise<GrantDetails>
Parameters
- request: { grantId: string }
- call: AuthCallContext
Returns Promise<GrantDetails>

revokeGrant

revokeGrant(request: { grantId: string }, call: AuthCallContext): Promise<void>
Parameters
- request: { grantId: string }
- call: AuthCallContext
Returns Promise<void>

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider