Tenant API
Systemweite Tenant-Verwaltungsoperationen für mindzieStudio. Erstellen, auflisten, aktualisieren und löschen Sie Tenants über die Plattform hinweg.
WICHTIG: Alle Tenant-API-Endpunkte erfordern einen Global API Key. Reguläre, tenant-spezifische API-Schlüssel haben keinen Zugriff auf diese Endpunkte.
Funktionen
Verwaltung
Alle Tenants auflisten, Tenant-Details abrufen, neue Tenants erstellen und Tenant-Einstellungen aktualisieren. Benutzerlimits, Falllimits und Tenant-Eigenschaften konfigurieren.
Löschung
Tenants dauerhaft löschen mit einer dreifachen Verifizierung zur Sicherheit. Beinhaltet bewährte Verfahren für Datenexport und sichere Löschprozesse.
Verfügbare Endpunkte
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/tenant |
Alle Tenants auflisten |
| GET | /api/tenant/{tenantId} |
Tenant anhand der ID abrufen |
| POST | /api/tenant |
Einen Tenant erstellen |
| PUT | /api/tenant |
Einen Tenant aktualisieren |
| DELETE | /api/tenant |
Einen Tenant löschen |
Tenant-Objektfelder
| Feld | Typ | Beschreibung |
|---|---|---|
tenantId |
GUID | Eindeutiger Bezeichner für den Tenant |
name |
string | Eindeutiger Systemname (wird in URLs verwendet) |
displayName |
string | Leserlicher Anzeigename |
description |
string | Beschreibung des Tenants |
caseCount |
integer | Gesamtzahl der Fälle |
maxUserCount |
integer | Maximal erlaubte Benutzeranzahl |
maxAnalystCount |
integer | Maximal erlaubte Analystenanzahl |
userCount |
integer | Aktuelle Benutzeranzahl |
analystCount |
integer | Aktuelle Analystenanzahl |
isDisabled |
boolean | Ob der Tenant deaktiviert ist |
isAcademic |
boolean | Ob es sich um einen akademischen Tenant handelt |
preRelease |
boolean | Ob der Tenant Pre-Release-Funktionen besitzt |
dateCreated |
datetime | Erstellungsdatum des Tenants |
Authentifizierung
| Endpunkt | API-Schlüsseltyp | Zugriff |
|---|---|---|
Alle /api/tenant Endpunkte |
Global API Key | Erforderlich |
| Tenant API Key | 401 Unauthorized |
Globale API-Schlüssel können über die Admin-Oberfläche unter /admin/global-api-keys erstellt werden.
Siehe Authentifizierung für Details zu API-Schlüsseltypen und deren Verwendung.
Schnellstart
# Alle Tenants auflisten (Global API Key erforderlich)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Einen bestimmten Tenant abrufen
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Wichtige Hinweise
- Nur globale API-Schlüssel: Alle Tenant-Endpunkte erfordern globale API-Schlüssel
- Lizenzgrenzen beachten: Überwachen Sie Tenant-Zahlen im Verhältnis zu den Lizenzbeschränkungen
- Destruktive Vorgänge: Tenant-Löschung ist dauerhaft und nicht rückgängig zu machen
- Dreifache Verifizierung: Löschvorgänge erfordern, dass ID, Name und Anzeigename exakt übereinstimmen
- Deaktivieren vs. Löschen: Erwägen Sie, Tenants zu deaktivieren, um Daten zu erhalten und dennoch den Zugriff zu verhindern