User API
Beheer gebruikers binnen het mindzieStudio-platform. Maak gebruikers aan, werk ze bij en wijs ze toe aan tenants met flexibele API-scopes.
Functies
Globale Operaties
Systeembreed gebruikersbeheer met een Global API Key. Lijst alle gebruikers, maak gebruikers aan, werk eigenschappen bij en beheer tenant-toewijzingen over het hele platform.
Tenant Operaties
Tenant-geschaald gebruikersbeheer dat werkt met zowel Global als Tenant API Keys. Beheer gebruikers binnen een specifieke tenant-context.
Rollen & Rechten
Gebruikersrollen definiëren toegangslevels en mogelijkheden. Begrijp de rolhiërarchie, serviceaccounts en best practices voor toegangsbeheer.
API Scopes
De User API heeft twee scopes:
| Scope | Basis Pad | API Key Vereist |
|---|---|---|
| Global | /api/user |
Global API Key |
| Tenant-geschaald | /api/tenant/{tenantId}/user |
Global of Tenant API Key |
Beschikbare Endpoints
Globale Gebruiker Endpoints
| Methode | Endpoint | Beschrijving |
|---|---|---|
| GET | /api/user |
Lijst alle gebruikers |
| POST | /api/user |
Maak een gebruiker aan |
| GET | /api/user/{userId} |
Verkrijg gebruiker op ID |
| PUT | /api/user/{userId} |
Werk gebruiker bij |
| GET | /api/user/by-email/{email} |
Verkrijg gebruiker op e-mail |
| GET | /api/user/{userId}/tenants |
Verkrijg gebruikers tenants |
Tenant-geschaalde Gebruiker Endpoints
| Methode | Endpoint | Beschrijving |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
Lijst tenantgebruikers |
| POST | /api/tenant/{tenantId}/user |
Maak gebruiker aan binnen tenant |
| GET | /api/tenant/{tenantId}/user/{userId} |
Verkrijg gebruiker binnen tenant |
| PUT | /api/tenant/{tenantId}/user/{userId} |
Werk gebruiker bij binnen tenant |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
Verkrijg op e-mail binnen tenant |
| POST | /api/tenant/{tenantId}/user/{userId} |
Wijs gebruiker toe aan tenant |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
Verwijder uit tenant |
Gebruikersrollen
| Rol (weergave) | API rolnaam | Niveau | Beschrijving |
|---|---|---|---|
| Server Administrator | TenantAdmin |
Systeem | Hoogste toegang. Volledige toegang over alle tenants en de server. |
| Administrator | Administrator |
Tenant | Volledige administratieve bevoegdheid binnen een tenant. |
| IT Admin | ITAdmin |
Tenant | Integraties, verbindingen en globale API keys. |
| Analyst | Analyst |
Project | Maak en beheer analyses, dashboards en onderzoeken. |
| Developer | Developer |
Project | Bouw integraties, beheer acties en apps. |
| User | User |
Alleen-lezen | Bekijk dashboards en analyses; kan inhoud niet wijzigen. |
Zie Rollen & Rechten voor de volledige rolhandleiding.
Authenticatie
| Endpoint Scope | API Key Type | Toegang |
|---|---|---|
Global (/api/user) |
Global API Key | Alle tenants |
| Tenant-geschaald | Global API Key | Alle tenants |
| Tenant-geschaald | Tenant API Key | Alleen eigen tenant |
Zie Authenticatie voor details over API key types en gebruik.
Snel Starten
# Lijst alle gebruikers (Global API key vereist)
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Lijst gebruikers in een tenant (Tenant API key werkt)
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
Belangrijke Notities
- Global vs Tenant Keys: Gebruik tenant-geschaalde keys voor de meeste operaties; bewaar globale keys voor systeembeheer
- Gebruiker Deactiveren: Gebruik
disabled: truein plaats van gebruikers te verwijderen om auditrails te behouden - Service Accounts: Alleen Server Administrator (
TenantAdmin) en Administrator rollen kunnen serviceaccounts zijn - Capaciteitslimieten: Tenants hebben configureerbare limieten voor gebruikers en analisten