Skip to main content
DELETE
CLI

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

id
string
required

Tenant to destroy. Accepts the canonical tenant_… form or the external_id:<value> form.

Response

OK

Tenant is the customer's organization as a readable record rather than an echo. It carries no spec: a tenant is never configured, only asserted, so everything about it lives in the metadata envelope — external_id is the key the customer asserted it under, name is the most recent name they asserted, and updated_at is therefore when the tenant was last asserted.

metadata
object
required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

state
enum<string>
required
read-only

The current lifecycle state of the tenant. Output only.

Available options:
STATE_UNSPECIFIED,
STATE_ACTIVE,
STATE_ERASING
info
object

TenantInfo provides read-only server-derived data about a tenant.