Tenants
List, create, update and delete an organization's tenants.
list_tenants
List an organization’s tenants, with each tenant’s join mode. Maps to
GET /organizations/:org/tenants.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
Returns the list of tenants.
create_tenant
Create a tenant. Only the name and logo are set here; set the join mode
afterwards with update_tenant. Maps to POST /organizations/:org/tenants.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
name | string | Yes | Tenant name, e.g. Acme |
logo | string (URL) | No | Logo URL |
Returns the created tenant.
update_tenant
Change a tenant’s name, logo or join mode. The fields you pass are the fields
that change. Maps to PATCH /organizations/:org/tenants/:tenant_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant to update |
name | string | No | New name |
logo | string (URL) | No | New logo URL |
mode | closed, public, workspace or domain | No | Join mode |
workspaces | array of { provider, domain } | No | For workspace mode: the SSO provider (e.g. google, ms) and the workspace domain that proves membership |
email_domains | array of string | No | For domain mode, e.g. ["acme.com"] |
closed and public take no configuration.
Returns the updated tenant.
delete_tenant
Soft-delete a tenant. An organization keeps at least one tenant — deleting the
last one is a 409. Maps to DELETE /organizations/:org/tenants/:tenant_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant to delete |
Returns OK (no content).