Tenant API
Systeemniveau tenantbeheer operaties voor mindzieStudio. Maak tenants aan, lijst ze op, werk ze bij en verwijder tenants op het platform.
BELANGRIJK: Alle Tenant API-eindpunten vereisen een Global API Key. Reguliere tenant-specifieke API-sleutels hebben geen toegang tot deze eindpunten.
Functies
Beheer
Lijst alle tenants, haal tenantdetails op, maak nieuwe tenants aan en werk tenantinstellingen bij. Configureer gebruikerslimieten, caselimieten en tenant-eigenschappen.
Verwijdering
Verwijder tenants permanent met drievoudige verificatie voor veiligheid. Bevat best practices voor data-export en veilige verwijderingsworkflows.
Beschikbare Eindpunten
| Methode | Eindpunt | Beschrijving |
|---|---|---|
| GET | /api/tenant |
Lijst alle tenants |
| GET | /api/tenant/{tenantId} |
Haal tenant op via ID |
| POST | /api/tenant |
Maak een tenant aan |
| PUT | /api/tenant |
Werk een tenant bij |
| DELETE | /api/tenant |
Verwijder een tenant |
Tenant Object Velden
| Veld | Type | Beschrijving |
|---|---|---|
tenantId |
GUID | Unieke identificatie voor de tenant |
name |
string | Unieke systeemnaam (gebruikt in URL’s) |
displayName |
string | Mensvriendelijke weergavenaam |
description |
string | Beschrijving van de tenant |
caseCount |
integer | Totaal aantal cases |
maxUserCount |
integer | Maximaal toegestane gebruikers |
maxAnalystCount |
integer | Maximaal toegestane analisten |
userCount |
integer | Huidig aantal gebruikers |
analystCount |
integer | Huidig aantal analisten |
isDisabled |
boolean | Of de tenant is uitgeschakeld |
isAcademic |
boolean | Of dit een academische tenant is |
preRelease |
boolean | Of de tenant pre-release functies heeft |
dateCreated |
datetime | Wanneer de tenant is aangemaakt |
Authenticatie
| Eindpunt | API Key Type | Toegang |
|---|---|---|
Alle /api/tenant eindpunten |
Global API Key | Vereist |
| Tenant API Key | 401 Unauthorized |
Global API keys kunnen worden aangemaakt via de admin interface op /admin/global-api-keys.
Zie Authenticatie voor details over API-sleutels typen en gebruik.
Snel Starten
# Lijst alle tenants (Global API key vereist)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Haal een specifieke tenant op
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Belangrijke Opmerkingen
- Alleen Global API Keys: Alle tenant-eindpunten vereisen Global API keys
- Licentie Limieten: Houd tenant aantallen in de gaten ten opzichte van licentie limieten
- Destructieve Operaties: Tenant verwijdering is permanent en onomkeerbaar
- Drievoudige Verificatie: Verwijderoperaties vereisen dat ID, naam en weergavenaam exact overeenkomen
- Uitschakelen vs Verwijderen: Overweeg tenants uit te schakelen om data te behouden terwijl toegang wordt geblokkeerd