• management
• ManagementClient
• ManagementClientOptions

Interface ManagementClientOptions

Base configuration options for the Management Client. Extends the Fern client options but excludes token and environment as these are handled by our wrapper.

interface ManagementClientOptions {
headers?: Record<string, Supplier<string | null | undefined>>;
timeoutInSeconds?: number;
maxRetries?: number;
logging?: LogConfig | Logger;
domain: string;
audience?: string;
telemetry?: boolean;
clientInfo?: { name: string; [key: string]: unknown };
withCustomDomainHeader?: string;
}

Hierarchy (View Summary)

• Omit<
  ManagementClient.Options,
  "token"
  | "environment"
  | "fetcher"
  | "baseUrl"
  | "fetch",
  >
  • ManagementClientOptions
    • ManagementClientOptionsWithToken
    • ManagementClientOptionsWithClientSecret
    • ManagementClientOptionsWithClientAssertion

Index

Properties

headers?timeoutInSeconds?maxRetries?logging?domainaudience?telemetry?clientInfo?withCustomDomainHeader?

Properties

Optionalheaders

headers?: Record<string, Supplier<string | null | undefined>>

Additional headers to include in requests.

OptionaltimeoutInSeconds

timeoutInSeconds?: number

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

OptionalmaxRetries

maxRetries?: number

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

Optionallogging

logging?: LogConfig | Logger

Configure logging for the client.

domain

domain: string

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

Optionalaudience

audience?: string

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

Default Value

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

Optionaltelemetry

telemetry?: boolean

Enable/disable telemetry. Defaults to true

Default Value

trueCopy

OptionalclientInfo

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

Custom client information for telemetry

OptionalwithCustomDomainHeader

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.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties headerstimeoutInSecondsmaxRetriesloggingdomainaudiencetelemetryclientInfowithCustomDomainHeader