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

    Type Alias BaseClientOptions

    BaseClientOptions: {
        environment?: Supplier<ManagementEnvironment | string>;
        baseUrl?: Supplier<string>;
        tenantDomain?: string;
        headers?: Record<
            string,
            string
            | Supplier<string | null | undefined>
            | null
            | undefined,
        >;
        timeoutInSeconds?: number;
        maxRetries?: number;
        fetch?: typeof __type;
        fetcher?: FetchFunction;
        logging?: LogConfig | Logger;
        stream?: {
            reconnectionEnabled?: boolean;
            maxReconnectionAttempts?: number;
        };
        auth?: AuthOption;
    } & AuthOptions

    Type Declaration

    • Optionalenvironment?: Supplier<ManagementEnvironment | string>
    • OptionalbaseUrl?: Supplier<string>

      Specify a custom URL to connect the client to.

    • OptionaltenantDomain?: string

      Defaults to "{TENANT}.auth0.com".

    • Optionalheaders?: Record<string, string | Supplier<string | null | undefined> | null | undefined>

      Additional headers to include in requests.

    • OptionaltimeoutInSeconds?: number

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

    • OptionalmaxRetries?: number

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

    • Optionalfetch?: typeof __type

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

    • Optionalfetcher?: FetchFunction
    • Optionallogging?: LogConfig | Logger

      Configure logging for the client.

    • Optionalstream?: { reconnectionEnabled?: boolean; maxReconnectionAttempts?: number }

      Default options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints.

    • Optionalauth?: AuthOption

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

    Settings
    Member Visibility