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.

Information

Plans Entreprise uniquement

L'API administrateur n'est disponible que sur les plans Entreprise, et l'accès n'est pas en libre-service. Sur les autres plans, vous ne pouvez pas créer de clé API administrateur, et une clé API standard ne fonctionne pas avec les endpoints administrateur. Pour demander l'accès, contactez votre équipe de compte Mistral ou notre équipe commerciale.

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 (page, page_size, search) ou créez-en un. name est obligatoire ; description est facultative.

# List groups
curl https://api.mistral.ai/v1/admin/user-groups \
  -H "x-api-key: $ADMIN_API_KEY"

# Create a group
curl -X POST https://api.mistral.ai/v1/admin/user-groups \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"name": "Interns", "description": "User group for interns"}'

# List groups
curl https://api.mistral.ai/v1/admin/user-groups \
  -H "x-api-key: $ADMIN_API_KEY"

# Create a group
curl -X POST https://api.mistral.ai/v1/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://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"

curl -X PATCH https://api.mistral.ai/v1/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://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"

curl https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"

curl -X PATCH https://api.mistral.ai/v1/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://api.mistral.ai/v1/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.

# List members
curl https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/members \
  -H "x-api-key: $ADMIN_API_KEY"

# Add members
curl -X POST https://api.mistral.ai/v1/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>"]}'

# Remove members
curl -X DELETE https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/members \
  -H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"user_uuids": ["<USER_UUID_1>"]}'

# List members
curl https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/members \
  -H "x-api-key: $ADMIN_API_KEY"

# Add members
curl -X POST https://api.mistral.ai/v1/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>"]}'

# Remove members
curl -X DELETE https://api.mistral.ai/v1/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

Attribuer un groupe à un espace de travail permet à ses membres d'accéder à cet espace de travail. Leurs rôles déterminent ce qu'ils peuvent y faire (voir Rôles).

Lorsque vous attribuez un groupe à un espace de travail :

Chaque membre du groupe reçoit les rôles attribués dans cet espace de travail.
Les nouveaux membres reçoivent les rôles lorsqu'ils rejoignent le groupe.
Les membres retirés du groupe perdent les rôles que celui-ci leur avait attribués, et perdent l'accès, sauf s'ils disposent de rôles provenant d'une autre source (voir Accès et rôles).

# List a group's Workspace assignments
curl https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/workspaces \
  -H "x-api-key: $ADMIN_API_KEY"

# Assign the group to a Workspace
curl -X POST https://api.mistral.ai/v1/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"]}'

# Update the roles on an assignment
curl -X PATCH https://api.mistral.ai/v1/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"]}'

# Remove the group from a workspace
curl -X DELETE https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/workspaces/<WORKSPACE_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"

# List a group's Workspace assignments
curl https://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/workspaces \
  -H "x-api-key: $ADMIN_API_KEY"

# Assign the group to a Workspace
curl -X POST https://api.mistral.ai/v1/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"]}'

# Update the roles on an assignment
curl -X PATCH https://api.mistral.ai/v1/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"]}'

# Remove the group from a workspace
curl -X DELETE https://api.mistral.ai/v1/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://api.mistral.ai/v1/admin/user-groups/<GROUP_UUID>/organization-role \
  -H "Content-Type: application/json" -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"organization_role": "member"}'

curl -X PATCH https://api.mistral.ai/v1/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://api.mistral.ai/v1/admin/roles \
  -H "x-api-key: $ADMIN_API_KEY"

curl https://api.mistral.ai/v1/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é.

Note

GET /api/admin/roles est la liste de référence des rôles et de leurs UUID.