Auth0 Node.js SDK - v7.2.0
    Preparing search index...

    Interface ManagementClientOptionsWithClientAssertion

    Configuration for client credentials authentication using JWT assertion. Use this for server-to-server authentication with a private key.

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      clientId: 'your-client-id',
      clientAssertionSigningKey: 'your-private-key'
    });
    interface ManagementClientOptionsWithClientAssertion {
        headers?: Record<string, Supplier<string | null | undefined>>;
        timeoutInSeconds?: number;
        maxRetries?: number;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        logging?: LogConfig
        | Logger;
        auth?: AuthOption;
        domain: string;
        audience?: string;
        telemetry?: boolean;
        clientInfo?: { name: string; [key: string]: unknown };
        withCustomDomainHeader?: string;
        clientId: string;
        clientAssertionSigningKey: string;
        clientAssertionSigningAlg?: string;
        useMTLS?: boolean;
    }

    Hierarchy (View Summary)

    Index
    headers? timeoutInSeconds? maxRetries? fetch? logging? auth? domain audience? telemetry? clientInfo? withCustomDomainHeader? clientId clientAssertionSigningKey clientAssertionSigningAlg? useMTLS?
    headers?: Record<string, Supplier<string | null | undefined>>

    Additional headers to include in requests.

    timeoutInSeconds?: number

    The default maximum time to wait for a response in seconds.

    maxRetries?: number

    The default number of times to retry the request. Defaults to 2.

    fetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation.

    Type Declaration

      • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    logging?: LogConfig | Logger

    Configure logging for the client.

    auth?: AuthOption

    Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options.

    domain: string

    Auth0 domain (e.g., 'your-tenant.auth0.com')

    audience?: string

    API audience. Defaults to https://{domain}/api/v2/

    https://{domain}/api/v2/

    telemetry?: boolean

    Enable/disable telemetry. Defaults to true

    true
    clientInfo?: { name: string; [key: string]: unknown }

    Custom client information for telemetry

    withCustomDomainHeader?: string

    Custom domain Header to use for whitelisted requests. When provided, the Auth0-Custom-Domain header will be added automatically to supported endpoints. This works seamlessly with custom fetchers - both the custom domain logic and your custom fetcher will be applied.

    clientId: string

    Auth0 application client ID

    clientAssertionSigningKey: string

    Private key for signing the client assertion JWT

    clientAssertionSigningAlg?: string

    Algorithm for signing the client assertion. Defaults to RS256

    useMTLS?: boolean

    Enable mTLS for token endpoint calls.

    mTLS (RFC 8705) is a transport-layer concern that is independent of the client authentication method: a client authenticating with private_key_jwt can still present a TLS client certificate to obtain a certificate-bound access token. This mirrors v6, which added the mtls. endpoint alias from useMTLS alone regardless of the auth method.

    Settings
    Member Visibility

    On This Page
    Properties