Benutzer-API
Verwalten Sie Benutzer über die gesamte mindzieStudio-Plattform. Erstellen, aktualisieren und weisen Sie Benutzern flexible API-Berechtigungen zu.
Funktionen
Globale Operationen
Systemweite Benutzerverwaltung mit einem Globalen API-Schlüssel. Alle Benutzer auflisten, Benutzer erstellen, Eigenschaften aktualisieren und Tenant-Zuweisungen über die gesamte Plattform verwalten.
Tenant-Operationen
Benutzerverwaltung im Tenant-Kontext, die mit Globalen oder Tenant-API-Schlüsseln funktioniert. Verwalten Sie Benutzer innerhalb eines bestimmten Tenants.
Rollen & Berechtigungen
Benutzerrollen definieren Zugriffslevel und Fähigkeiten. Verstehen Sie die Rollenhierarchie, Servicekonten und Best Practices für das Zugriffsmanagement.
Rollen & Berechtigungen anzeigen
API-Berechtigungen
Die Benutzer-API hat zwei Berechtigungen:
| Berechtigung | Basis-Pfad | API-Schlüssel erforderlich |
|---|---|---|
| Global | /api/user |
Globaler API-Schlüssel |
| Tenant-bezogen | /api/tenant/{tenantId}/user |
Globaler oder Tenant-API-Schlüssel |
Verfügbare Endpunkte
Globale Benutzerendpunkte
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/user |
Alle Benutzer auflisten |
| POST | /api/user |
Benutzer erstellen |
| GET | /api/user/{userId} |
Benutzer nach ID abrufen |
| PUT | /api/user/{userId} |
Benutzer aktualisieren |
| GET | /api/user/by-email/{email} |
Benutzer nach E-Mail abrufen |
| GET | /api/user/{userId}/tenants |
Benutzer-Tenants abrufen |
Tenant-bezogene Benutzerendpunkte
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
Tenant-Benutzer auflisten |
| POST | /api/tenant/{tenantId}/user |
Benutzer im Tenant erstellen |
| GET | /api/tenant/{tenantId}/user/{userId} |
Benutzer im Tenant abrufen |
| PUT | /api/tenant/{tenantId}/user/{userId} |
Benutzer im Tenant aktualisieren |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
Benutzer per E-Mail im Tenant abrufen |
| POST | /api/tenant/{tenantId}/user/{userId} |
Benutzer dem Tenant zuweisen |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
Benutzer aus Tenant entfernen |
Benutzerrollen
| Rolle (Anzeige) | API-Rollenname | Ebene | Beschreibung |
|---|---|---|---|
| Serveradministrator | TenantAdmin |
System | Höchster Zugriff. Vollzugriff auf alle Tenants und den Server. |
| Administrator | Administrator |
Tenant | Volle administrative Befugnis innerhalb eines Tenants. |
| IT-Administrator | ITAdmin |
Tenant | Integrationen, Verbindungen und globale API-Schlüssel. |
| Analyst | Analyst |
Projekt | Analysen, Dashboards und Untersuchungen erstellen und verwalten. |
| Entwickler | Developer |
Projekt | Integrationen entwickeln, Aktionen und Apps verwalten. |
| Benutzer | User |
Nur-Lesen | Dashboards und Analysen ansehen; keine Inhaltsänderungen möglich. |
Siehe Rollen & Berechtigungen für den vollständigen Rollenguide.
Authentifizierung
| Endpunkt-Bereich | API-Schlüssel-Typ | Zugriff |
|---|---|---|
Global (/api/user) |
Globaler API-Schlüssel | Alle Tenants |
| Tenant-bezogen | Globaler API-Schlüssel | Alle Tenants |
| Tenant-bezogen | Tenant-API-Schlüssel | Nur eigener Tenant |
Siehe Authentifizierung für Details zu API-Schlüsseltypen und Nutzung.
Schnellstart
# Alle Benutzer auflisten (Globaler API-Schlüssel erforderlich)
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Benutzer in einem Tenant auflisten (Tenant-API-Schlüssel möglich)
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
Wichtige Hinweise
- Globale vs. Tenant-Schlüssel: Verwenden Sie für die meisten Vorgänge tenant-bezogene Schlüssel; reservieren Sie globale Schlüssel für Systemadministration
- Benutzerdeaktivierung: Verwenden Sie
disabled: truestatt Benutzer zu löschen, um Prüfpfade zu erhalten - Servicekonten: Nur Serveradministrator (
TenantAdmin) und Administrator-Rollen können Servicekonten sein - Kapazitätsbeschränkungen: Tenants haben konfigurierbare Benutzer- und Analysten-Limits