Interface AdminClientOptions

Options for an AdminClient.

interface AdminClientOptions {
    apiVersion?: string;
    baseUrl?: string;
    fetch?: FetchLike;
    rateLimit?: RateLimitConfig;
    timeoutMs?: number;
    token?: string;
}

Index

Properties

apiVersion? baseUrl? fetch? rateLimit? timeoutMs? token?

Properties

`Optional` `Readonly`apiVersion

apiVersion?: string

The API version prefix applied to every request path. Defaults to v2.

`Optional` `Readonly`baseUrl

baseUrl?: string

The control-plane base URL. Defaults to https://api.mxraven.com.

`Optional` `Readonly`fetch

fetch?: FetchLike

The fetch implementation to use. Defaults to the global fetch.

`Optional` `Readonly`rateLimit

rateLimit?: RateLimitConfig

Client-wide rate-limit behaviour. Defaults to defaultRateLimitConfig.

`Optional` `Readonly`timeoutMs

timeoutMs?: number

The request timeout in milliseconds. Defaults to 60000.

`Optional` `Readonly`token

token?: string

A ZITADEL-issued bearer access token. Omit for public operations only.