API Utilisateur
Gérez les utilisateurs sur l'ensemble de la plateforme mindzieStudio. Créez, mettez à jour et assignez des utilisateurs aux tenants avec des scopes d’API flexibles.
Fonctionnalités
Opérations Globales
Gestion des utilisateurs à l’échelle du système avec une clé d’API globale. Listez tous les utilisateurs, créez des utilisateurs, mettez à jour les propriétés et gérez les affectations de tenants sur toute la plateforme.
Opérations Tenant
Gestion des utilisateurs dans le cadre d’un tenant, fonctionnant avec des clés d’API Global ou Tenant. Gérez les utilisateurs au sein d’un contexte tenant spécifique.
Rôles & Permissions
Les rôles utilisateurs définissent les niveaux d’accès et les capacités. Comprenez la hiérarchie des rôles, les comptes de service, et les bonnes pratiques pour la gestion des accès.
Scopes de l’API
L’API Utilisateur dispose de deux scopes :
| Scope | Chemin de base | Clé API requise |
|---|---|---|
| Global | /api/user |
Clé d’API Globale |
| Tenant-scoped | /api/tenant/{tenantId}/user |
Clé d’API Globale ou Tenant |
Endpoints Disponibles
Endpoints Utilisateurs Globaux
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/user |
Lister tous les utilisateurs |
| POST | /api/user |
Créer un utilisateur |
| GET | /api/user/{userId} |
Obtenir un utilisateur par ID |
| PUT | /api/user/{userId} |
Mettre à jour un utilisateur |
| GET | /api/user/by-email/{email} |
Obtenir un utilisateur par email |
| GET | /api/user/{userId}/tenants |
Obtenir les tenants d’un utilisateur |
Endpoints Utilisateurs Tenant-Scoped
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
Lister les utilisateurs du tenant |
| POST | /api/tenant/{tenantId}/user |
Créer un utilisateur dans le tenant |
| GET | /api/tenant/{tenantId}/user/{userId} |
Obtenir un utilisateur dans le tenant |
| PUT | /api/tenant/{tenantId}/user/{userId} |
Mettre à jour un utilisateur dans le tenant |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
Obtenir par email dans le tenant |
| POST | /api/tenant/{tenantId}/user/{userId} |
Assigner un utilisateur au tenant |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
Supprimer du tenant |
Rôles Utilisateurs
| Rôle (affichage) | Nom du rôle API | Niveau | Description |
|---|---|---|---|
| Administrateur Serveur | TenantAdmin |
Système | Accès le plus élevé. Portée complète sur tous les tenants et le serveur. |
| Administrateur | Administrator |
Tenant | Autorité administrative complète au sein d’un tenant. |
| Admin IT | ITAdmin |
Tenant | Intégrations, connexions et clés API globales. |
| Analyste | Analyst |
Projet | Créer et gérer analyses, tableaux de bord et enquêtes. |
| Développeur | Developer |
Projet | Construire des intégrations, gérer actions et applications. |
| Utilisateur | User |
Lecture seule | Voir tableaux de bord et analyses ; ne peut pas modifier le contenu. |
Voir Rôles & Permissions pour le guide complet des rôles.
Authentification
| Scope Endpoint | Type de clé API | Accès |
|---|---|---|
Global (/api/user) |
Clé d’API Globale | Tous les tenants |
| Tenant-scoped | Clé d’API Globale | Tous les tenants |
| Tenant-scoped | Clé d’API Tenant | Tenant propre uniquement |
Voir Authentification pour les détails sur les types de clés API et leur utilisation.
Démarrage rapide
# Lister tous les utilisateurs (clé API globale requise)
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Lister les utilisateurs d’un tenant (clé API tenant valide)
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
Notes Importantes
- Clés Globales vs Tenant : Utilisez les clés tenant-scoped pour la plupart des opérations ; réservez les clés globales pour l’administration système.
- Désactivation des utilisateurs : Utilisez
disabled: trueplutôt que de supprimer les utilisateurs pour préserver les pistes d’audit. - Comptes de service : Seuls les rôles Administrateur Serveur (
TenantAdmin) et Administrateur peuvent être des comptes de service. - Limites de capacité : Les tenants ont des limites configurables pour les utilisateurs et les analystes.