Class JwtExchanger`Abstract`

Base class for exchanging a JWT for a VeraId credential.

Hierarchy (View Summary)

Exchanger
- JwtExchanger
  - GithubExchanger

Index

Constructors

Methods

exchange fetchJwt generateVauthAuthHeader

Constructors

constructor

new JwtExchanger(): JwtExchanger
Returns JwtExchanger
Inherited from Exchanger.constructor

Methods

exchange

exchange(
vauthCredentialUrl: URL,
options?: Partial<ExchangeOptions>,
): Promise<VeraidCredential>
Exchange the credentials for a VeraId credential.
Parameters
- vauthCredentialUrl: URL
  The VeraId Authority endpoint to obtain the credential.
- options: Partial<ExchangeOptions> = {}
Returns Promise<VeraidCredential>
The credential if successful.
Inherited from Exchanger.exchange
- Defined in Exchanger.ts:17

`Protected` `Abstract`fetchJwt

fetchJwt(audience: string, timeoutMs: number): Promise<string>
Fetch the JWT from the hosting service.
Parameters
- audience: string
  The audience of the JWT.
- timeoutMs: number
  The timeout for in milliseconds.
Returns Promise<string>
The JWT.
- Defined in JwtExchanger.ts:13

`Protected`generateVauthAuthHeader

generateVauthAuthHeader(
vauthCredentialUrl: URL,
timeoutMs: number,
): Promise<string>
Generate the Authorization request header for the VeraId Authority credential endpoint.
Parameters
- vauthCredentialUrl: URL
  The VeraId Authority endpoint to obtain the credential.
- timeoutMs: number
  The timeout (in milliseconds) to obtain the original credential.
Returns Promise<string>
The authorization header.
Overrides Exchanger.generateVauthAuthHeader
- Defined in JwtExchanger.ts:15