Class AdminClient

Client for the mxRaven control-plane v2 REST API.

Construct one with a ZITADEL-issued bearer access token, then reach resource families through a Workspace. Public operations, such as the tenant login context, work with a blank token.

The client is safe for concurrent use. Every network operation accepts an AbortSignal so callers can cancel it.

Example

const admin = new AdminClient({ token: process.env.MXRAVEN_TOKEN });
for await (const domain of admin.workspace("my-workspace").domains().list()) {
  console.log(domain.domainName, domain.status);
}

Index

Constructors

constructor

new AdminClient(options?: AdminClientOptions): AdminClient
Parameters
- options: AdminClientOptions = {}
  The base URL, token, API version, rate limit, and transport.
Returns AdminClient

Throws
Error When an option is invalid.
- Defined in client.ts:225

Properties

`Readonly`apiVersion

apiVersion: string

The API version prefix applied to every request path.

`Readonly`baseUrl

baseUrl: string

The control-plane base URL, without a trailing slash.

`Readonly`rateLimit

rateLimit: RateLimitConfig

The client-wide rate-limit behaviour.

`Static` `Readonly`defaultApiVersion

defaultApiVersion: "v2"

The default control-plane API version prefix.

`Static` `Readonly`defaultBaseUrl

defaultBaseUrl: "https://api.mxraven.com"

The default mxRaven control-plane base URL.

Accessors

token

get token(): string
The bearer token in use, or an empty string.

Returns string
- Defined in client.ts:248

Methods

auth

auth(): AuthClient
The public tenant-context family. Works with a blank token.

Returns AuthClient
A client for the public authentication family.
- Defined in client.ts:272

delete

delete(path: string, options?: RequestOptions): Promise<Response>
Issues a DELETE request.
Parameters
- path: string
  A client-relative path; the API version is prepended.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Response>
The decoded response.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:331

get

get(
    path: string,
    query?: Readonly<Record<string, string | number | boolean | undefined>>,
    options?: RequestOptions,
): Promise<Response>
Issues a GET request.
Parameters
- path: string
  A client-relative path; the API version is prepended.
- Optionalquery: Readonly<Record<string, string | number | boolean | undefined>>
  Optional query parameters.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Response>
The decoded response.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:287

paged

paged<T>(
    path: string,
    query?: Readonly<Record<string, string | number | boolean | undefined>>,
    options?: RequestOptions,
): Promise<Paged<T>>
Issues a GET and wraps the response in a lazily auto-paginating Paged. Subsequent pages are fetched by re-issuing the same request with the next page_token, only as the async iterator advances.
Type Parameters
- T
  The element type.
Parameters
- path: string
  A client-relative path; the API version is prepended.
- Optionalquery: Readonly<Record<string, string | number | boolean | undefined>>
  Optional query parameters.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Paged<T>>
A lazily paginating collection over the response items.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:421

post

post(path: string, body: unknown, options?: RequestOptions): Promise<Response>
Issues a POST request with a JSON body.
Parameters
- path: string
  A client-relative path; the API version is prepended.
- body: unknown
  The request body, serialized as JSON.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Response>
The decoded response.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:302

put

put(path: string, body: unknown, options?: RequestOptions): Promise<Response>
Issues a PUT request with a JSON body.
Parameters
- path: string
  A client-relative path; the API version is prepended.
- body: unknown
  The request body, serialized as JSON.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Response>
The decoded response.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:317

request

request(
    method: string,
    path: string,
    query?: Readonly<Record<string, string | number | boolean | undefined>>,
    body?: unknown,
    options?: RequestOptions,
): Promise<Response>
Sends a request to the control plane.

A non-success status is decoded as an RFC 9457 problem and thrown as an ApiException. GET and DELETE requests are retried on 429 according to AdminClient.rateLimit; POST and PUT are not.
Parameters
- method: string
  The HTTP method.
- path: string
  A client-relative path; the API version is prepended.
- Optionalquery: Readonly<Record<string, string | number | boolean | undefined>>
  Optional query parameters.
- Optionalbody: unknown
  The request body, serialized as JSON, or undefined for none.
- options: RequestOptions = {}
  Optional cancellation signal.
Returns Promise<Response>
The decoded response.

Throws
ApiException When the control plane returns a non-success status.
- Defined in client.ts:352

workspace

workspace(tenantSlug: string): Workspace
Binds a tenant. The returned Workspace exposes every tenant-scoped resource family without repeating the slug.
Parameters
- tenantSlug: string
  The tenant slug to bind.
Returns Workspace
A workspace bound to the given tenant.
- Defined in client.ts:261

Class AdminClient

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AdminClient

Throws

Properties

ReadonlyapiVersion

ReadonlybaseUrl

ReadonlyrateLimit

Static ReadonlydefaultApiVersion

Static ReadonlydefaultBaseUrl

Accessors

token

Returns string

Methods

auth

Returns AuthClient

delete

Parameters

Returns Promise<Response>

Throws

get

Parameters

Returns Promise<Response>

Throws

paged

Type Parameters

Parameters

Returns Promise<Paged<T>>

Throws

post

Parameters

Returns Promise<Response>

Throws

put

Parameters

Returns Promise<Response>

Throws

request

Parameters

Returns Promise<Response>

Throws

workspace

Parameters

Returns Workspace

Settings

On This Page

`Readonly`apiVersion

`Readonly`baseUrl

`Readonly`rateLimit

`Static` `Readonly`defaultApiVersion

`Static` `Readonly`defaultBaseUrl