Interface IAuth0Client

users

• users(token: string, tokenType?: TokenType): IUsersClient

  Creates a client for interacting with the Auth0 Management API's user endpoints.

  Parameters

  • token: string

    An access token with the required permissions for the management operations.

  • OptionaltokenType: TokenType

    Optional token type ('Bearer' or 'DPoP'). Defaults to the client's configured token type.

  Returns IUsersClient

  An IUsersClient instance configured with the provided token.

getDPoPHeaders

• getDPoPHeaders(params: DPoPHeadersParams): Promise<Record<string, string>>

  Generates DPoP headers for making authenticated requests to custom APIs. This method creates the necessary HTTP headers (Authorization and DPoP) to securely bind the access token to a specific API request.

  Parameters

  • params: DPoPHeadersParams

    Parameters including the URL, HTTP method, access token, and token type.

  Returns Promise<Record<string, string>>

  A promise that resolves to an object containing the required headers.

  Example

  const credentials = await auth0.credentialsManager.getCredentials();
  const headers = await auth0.getDPoPHeaders({
    url: 'https://api.example.com/data',
    method: 'GET',
    accessToken: credentials.accessToken,
    tokenType: credentials.tokenType
  });
  
  fetch('https://api.example.com/data', { headers });
  Copy

customTokenExchange

• customTokenExchange(
      parameters: CustomTokenExchangeParameters,
  ): Promise<Credentials>

  Performs a Custom Token Exchange using RFC 8693. Exchanges an external identity provider token for Auth0 tokens.

  Parameters

  • parameters: CustomTokenExchangeParameters

    The token exchange parameters.

  Returns Promise<Credentials>

  A promise resolving with Auth0 credentials.

ReadonlywebAuth

ReadonlycredentialsManager

Readonlyauth