Tenants and Partners Reference
Admin endpoints for managing the tenancy hierarchy. For the concept overview, see Multi-tenancy.
Partners#
Super-admin only.
GET /v1/partners#
List all partners on the platform.
GET /v1/partners/{partner_id}#
Get partner details.
PUT /v1/partners/{partner_id}#
Update partner metadata.
1 | |
Tenants#
Partner admin and super admin.
GET /v1/tenants#
List tenants visible to the caller. Partner admins see their partner's tenants; super admins see all.
Query params: limit, cursor, partner_id (filter), status.
POST /v1/tenants#
Create a tenant.
1 2 3 4 5 6 7 8 9 | |
GET /v1/tenants/{tenant_id}#
Get tenant details.
PUT /v1/tenants/{tenant_id}#
Update tenant.
1 2 3 4 5 | |
Tenant templates#
Templates let you stamp out new tenants with consistent defaults (modules enabled, custom roles, pricing tier).
GET /v1/tenant-templates#
List available templates. Tenant-admin-level access.
POST /v1/tenant-templates#
Create a template.
1 2 3 4 5 6 7 8 9 10 | |
GET /v1/tenant-templates/{template_id}#
Get template details.
PUT /v1/tenant-templates/{template_id}#
Update a template.
DELETE /v1/tenant-templates/{template_id}#
Remove a template. Tenants previously created from it are unaffected.
POST /v1/tenant-templates/{template_id}/apply/{tenant_id}#
Apply a template to an existing tenant. Additive — enables listed modules, creates listed roles, sets budgets. Doesn't remove anything the tenant already has that's not in the template.
Suspending a tenant#
Set status: "suspended" on a tenant to immediately block all inference and most admin operations:
1 2 3 | |
Users in a suspended tenant get 403 TENANT_SUSPENDED on authenticated requests. Unsuspend by setting status: "active".
Partner-level suspension (status: "suspended" on a partner) suspends all tenants under that partner.