Class OauthCredentialProviderAbstract

Protectedconstructor

• new OauthCredentialProvider(
      options: {
          clientId: string;
          clientSecret?: string;
          scope?: string;
          tokenEndpointAuthMethod?: "client_secret_basic" | "client_secret_post";
          tokenLocation?: string;
          tokenName?: string;
          tokenPrefix?: string;
      } & (
          | { issuer: string }
          | { discoveryEndpoint: string }
          | {
              authorizationEndpoint?: string;
              endSessionEndpoint?: string;
              tokenEndpoint: string;
          }
      ),
      openId?: OpenIdConfiguration,
  ): OauthCredentialProvider

  Constructs the base of the credential providers. Only use this class to inherit the base methods and properties.

  Parameters

  • options: {
        clientId: string;
        clientSecret?: string;
        scope?: string;
        tokenEndpointAuthMethod?: "client_secret_basic" | "client_secret_post";
        tokenLocation?: string;
        tokenName?: string;
        tokenPrefix?: string;
    } & (
        | { issuer: string }
        | { discoveryEndpoint: string }
        | {
            authorizationEndpoint?: string;
            endSessionEndpoint?: string;
            tokenEndpoint: string;
        }
    )

    The credential provider configuration options.

  • OptionalopenId: OpenIdConfiguration

    An Open ID configuration used to configure this credential provider.

  Returns OauthCredentialProvider

Protected Optional_openId

Protected ReadonlyclientSecret

ProtectedcreateTokenRequest

• createTokenRequest(options: TokenRequestOptions): RequestInit

  Creates the configuration object for an OAuth2 token request.

  This function returns a RequestInit object that can be used with the fetch API to perform a token request. It builds the request using a POST method and the application/x-www-form-urlencoded content type. Depending on the authentication method (BASIC or POST) and the grant type (AUTHORIZATION_CODE or REFRESH_TOKEN), the appropriate headers and body parameters are conditionally included.

  • When using BASIC authentication and a client secret is provided, an Authorization header is added using Base64-encoded credentials (clientId:clientSecret).
  • For POST authentication, the client secret is added to the request body.
  • The request body is constructed with mandatory and optional parameters based on the grant type:
    • For the AUTHORIZATION_CODE grant, the code is included along with optional redirect_uri and code_verifier.
    • For the REFRESH_TOKEN grant, the refresh token is included if available.

  Parameters

  • options: TokenRequestOptions

    The options for the token request.

  Returns RequestInit

  The request configuration object, including method, headers, and body.

ProtectedgetTokenEndpoint

• getTokenEndpoint(): Promise<string>

  Retrieves the token endpoint URL for the OpenID provider. It first checks if the tokenEndpoint property is already set and returns it if available. If not, it retrieves the OpenID configuration via the openId() method, obtains the token endpoint from the configuration, and converts it to a string.

  Returns Promise<string>

  A promise that resolves to the token endpoint URL as a string.