Tenant API
System-level tenant management operations for mindzieStudio. Create, list, update, and delete tenants across the platform.
IMPORTANT: All Tenant API endpoints require a Global API Key. Regular tenant-specific API keys cannot access these endpoints.
Features
Management
List all tenants, retrieve tenant details, create new tenants, and update tenant settings. Configure user limits, case limits, and tenant properties.
Deletion
Permanently delete tenants with triple verification for safety. Includes best practices for data export and safe deletion workflows.
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/tenant |
List all tenants |
| GET | /api/tenant/{tenantId} |
Get tenant by ID |
| POST | /api/tenant |
Create a tenant |
| PUT | /api/tenant |
Update a tenant |
| DELETE | /api/tenant |
Delete a tenant |
Tenant Object Fields
| Field | Type | Description |
|---|---|---|
tenantId |
GUID | Unique identifier for the tenant |
name |
string | Unique system name (used in URLs) |
displayName |
string | Human-readable display name |
description |
string | Description of the tenant |
caseCount |
integer | Total number of cases |
maxUserCount |
integer | Maximum allowed users |
maxAnalystCount |
integer | Maximum allowed analysts |
userCount |
integer | Current number of users |
analystCount |
integer | Current number of analysts |
isDisabled |
boolean | Whether the tenant is disabled |
isAcademic |
boolean | Whether this is an academic tenant |
preRelease |
boolean | Whether tenant has pre-release features |
dateCreated |
datetime | When the tenant was created |
Authentication
| Endpoint | API Key Type | Access |
|---|---|---|
All /api/tenant endpoints |
Global API Key | Required |
| Tenant API Key | 401 Unauthorized |
Global API keys can be created through the admin interface at /admin/global-api-keys.
See Authentication for details on API key types and usage.
Quick Start
# List all tenants (Global API key required)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Get a specific tenant
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Important Notes
- Global API Keys Only: All tenant endpoints require Global API keys
- License Limits: Monitor tenant counts against license limits
- Destructive Operations: Tenant deletion is permanent and irreversible
- Triple Verification: Delete operations require ID, name, and display name to match exactly
- Disable vs Delete: Consider disabling tenants to preserve data while preventing access