Skip to main content

Class: abstract CredentialOrchestrator

Defines how Tokens are retrieved to be consumed within an application

See​

FetchClient

Extended by​

Constructors​

new CredentialOrchestrator()​

new CredentialOrchestrator(): CredentialOrchestrator

Returns​

CredentialOrchestrator

Methods​

on()​

on(eventName, handler): EventEmitter

binds event listeners to events throw by the CredentialOrchestrator

Parameters​

• eventName: string

• handler

Returns​

EventEmitter

off()​

off(eventName, handler): EventEmitter

Parameters​

• eventName: string

• handler

Returns​

EventEmitter

getToken()​

abstract getToken(options): Promise<null | Token>

Retrieves a valid Token to be used within an application

Parameters​

• options: AuthOptions

Returns​

Promise<null | Token>

getDPoPSignature()​

abstract getDPoPSignature(options): Promise<Request>

This method is used to generate a DPoP Proof for a HTTP request rather than simply returning an access token (to be used as a Bearer token)

Parameters​

• options: DPoPOptions

Returns​

Promise<Request>

Remarks​

This method is only documented as abstract, but is not marked abstract in the type definition. Not all implementations of CredentialOrchestrator will required this method.

See​

  • Okta Documentation: DPoP