Class OIDCClientCredentialsProvider

constructor

• new OIDCClientCredentialsProvider(
      __namedParameters: Partial<ClientSecretCredentials> & Omit<
          ClientSecretCredentials,
          "exchange",
      >,
  ): OIDCClientCredentialsProvider

  Parameters

  • __namedParameters: Partial<ClientSecretCredentials> & Omit<ClientSecretCredentials, "exchange">

  Returns OIDCClientCredentialsProvider

oidcAuth

updateClientPublicKey

• updateClientPublicKey(signingKey: CryptoKeyPair): Promise<void>

  This function should be called if the consumer of this auth provider changes the client keypair, or wishes to set the keypair after creating the object.

  Calling this function will (optionally) trigger a forcible token refresh using the cached refresh token, and update the auth server config with the current key.

  Parameters

  • signingKey: CryptoKeyPair

    the client signing key pair. Will be bound to the OIDC token and require a DPoP header, when set.

  Returns Promise<void>

withCreds

• withCreds(httpReq: HttpRequest): Promise<HttpRequest>

  Augment the provided http request with custom auth info to be used by backend services.

  Parameters

  • httpReq: HttpRequest

    Required. An http request pre-populated with the data public key.

  Returns Promise<HttpRequest>