Gérer les groupes et les rôles avec l’API Admin
Créez et gérez des groupes d’utilisateurs, attribuez-les à des espaces de travail et consultez les rôles. Pour en savoir plus sur les groupes, consultez Groupes.
Avant de commencer
Toutes les requêtes utilisent l’URL de base https://console.mistral.ai/api/admin et une clé API Admin dans l’en-tête x-api-key. Consultez Authentification et clés API Admin.
Gérer les groupes
Listez les groupes avec page, page_size et search, ou créez-en un. name est obligatoire. description et target_type sont facultatifs. Utilisez W pour un espace de travail et O pour une Organisation.
# Lister les groupes
curl https://console.mistral.ai/api/admin/user-groups \
-H "x-api-key: $ADMIN_API_KEY"
# Créer un groupe
curl -X POST https://console.mistral.ai/api/admin/user-groups \
-H "Content-Type: application/json" \
-H "x-api-key: $ADMIN_API_KEY" \
-d '{"name": "Interns", "description": "User group for interns"}'La réponse inclut l’uuid du groupe. Consultez, mettez à jour ou supprimez un groupe à l’aide de son UUID :
curl https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID> \
-H "x-api-key: $ADMIN_API_KEY"
curl -X PATCH https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID> \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"description": "Updated description"}'
curl -X DELETE https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID> \
-H "x-api-key: $ADMIN_API_KEY"Gérer les membres
Listez les membres, ou ajoutez ou retirez des membres en transmettant leurs identifiants dans le tableau user_uuids.
# Lister les membres
curl https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/members \
-H "x-api-key: $ADMIN_API_KEY"
# Ajouter des membres
curl -X POST https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/members \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"user_uuids": ["<USER_UUID_1>", "<USER_UUID_2>"]}'
# Retirer des membres
curl -X DELETE https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/members \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"user_uuids": ["<USER_UUID_1>"]}'Attribuer un groupe à un espace de travail
Pour ajouter tous les membres d’un groupe à un espace de travail, utilisez provision-workspace. Le paramètre workspace_role_name indique le nom du rôle à attribuer :
curl -X POST https://console.mistral.ai/api/admin/user-groups/provision-workspace \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{
"user_group_uuid": "<GROUP_UUID>",
"workspace_uuid": "<WORKSPACE_UUID>",
"workspace_role_name": "user"
}'Pour gérer individuellement les affectations aux espaces de travail, utilisez la sous-collection workspaces du groupe avec role_names. Consultez Rôles.
# Lister les affectations d’un groupe aux espaces de travail
curl https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/workspaces \
-H "x-api-key: $ADMIN_API_KEY"
# Attribuer le groupe à un espace de travail
curl -X POST https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/workspaces \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"workspace_uuid": "<WORKSPACE_UUID>", "role_names": ["user"]}'
# Mettre à jour les rôles d’une affectation
curl -X PATCH https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/workspaces/<WORKSPACE_UUID> \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"role_names": ["workspace_admin"]}'
# Retirer le groupe d’un espace de travail
curl -X DELETE https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/workspaces/<WORKSPACE_UUID> \
-H "x-api-key: $ADMIN_API_KEY"Définir le rôle Organisation d’un groupe
curl -X PATCH https://console.mistral.ai/api/admin/user-groups/<GROUP_UUID>/organization-role \
-H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
-d '{"organization_role": "member"}'Rôles
Listez les rôles disponibles et leurs UUID. Le contrôle d’accès basé sur les rôles (RBAC) doit être activé pour l’Organisation.
curl https://console.mistral.ai/api/admin/roles \
-H "x-api-key: $ADMIN_API_KEY"La réponse regroupe les rôles dans organization_roles et workspace_roles.
Rôles Organisation
role_name | Accès |
|---|---|
member | Utilisation des produits. Gestion du profil personnel. |
billing_manager | Abonnements, factures et moyens de paiement. Ne permet pas de modifier les paramètres de l’Organisation. |
organization_admin | Contrôle complet de l’Organisation. |
Rôles d’espace de travail
role_name | Accès |
|---|---|
user | le Chat et ses fonctionnalités. Aucun accès à Studio. |
dev | Studio et toutes ses fonctionnalités, y compris les agents et le fine-tuning. Aucun accès aux fonctionnalités de le Chat. |
mistral_code_user | Mistral Code. Nécessite un siège. |
billing | Rapports d’utilisation et de coûts uniquement. |
workspace_contributor | Toutes les fonctionnalités produit : user, dev, mistral_code_user. Aucun accès de gestion ni à nos outils d’observabilité. |
workspace_admin | Accès contributeur avec administration de l’espace de travail. Aucun accès à nos outils d’observabilité. |
observability_viewer | Accès à nos outils d’observabilité. |
GET /api/admin/roles est la liste de référence des rôles et de leurs UUID.