Class AuthClient

Public authentication-context operations under /v2/auth.

These calls are unauthenticated and work with a blank token.

Index

Constructors

Methods

Constructors

constructor

new AuthClient(options: AuthClientOptions): AuthClient
Parameters
- options: AuthClientOptions
  The underlying admin client.
Returns AuthClient
- Defined in auth/client.ts:29

Methods

loginContext

loginContext(
tenantSlug: string,
options?: RequestOptions,
): Promise<TenantLoginContext>
Resolves the public login context for a tenant.

Unknown, unavailable, suspended, deleted, and unprovisioned tenants all return the same not-found problem. The tenant path segment is URL-encoded.
Parameters
- tenantSlug: string
  The tenant slug to resolve.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantLoginContext>
The resolved tenant login context.

Throws
NotFoundException When the tenant cannot be resolved.
- Defined in auth/client.ts:46