Tenants API
The Tenants API provides endpoints for tenant provisioning, lifecycle management, and administration.
For dashboard instructions and general information about tenants, see the Tenants documentation.
Base Endpoint
/api/tenantsTenant Type
type Tenant = {
tenantId: string;
name: string;
status: 'Active' | 'Inactive' | 'Blocked';
description?: string;
email?: string;
adminId?: string;
settings?: Record<string, unknown>;
}Endpoints
| Method | Endpoint | Description | |
|---|---|---|---|
| POST | /api/tenants/{id}/activate | Activate a tenant | |
| POST | /api/tenants/{id}/deactivate | Deactivate a tenant | |
| POST | /api/tenants/{id}/block | Block a tenant | |
| PUT | /api/tenants/{id}/admin/{adminId} | Assign tenant admin | |
| POST | /api/tenants | Create a tenant | Similar to Entities API |
| PUT | /api/tenants | Update a tenant | Similar to Entities API |
| GET | /api/tenants/{id} | Get a tenant by ID | Similar to Entities API |
| GET | /api/tenants?page&size&sort&filter | List and filter by URI parameters | Similar to Entities API |
| POST | /api/tenants/search | Search tenants by POST | Similar to Entities API |
| DELETE | /api/tenants/{id} | Delete a tenant | Similar to Entities API |
| GET | /api/tenants/count | Count tenants | Similar to Entities API |
| POST | /api/tenants/count | Count filtered tenants | Similar to Entities API |
