Home
Admin

Gérer les espaces de travail avec l’API Admin

Gérez les espaces de travail et leurs membres à l’aide de l’API Admin.

i
Information

Réservé aux plans Entreprise

L'API administrateur n'est disponible que sur les plans Entreprise, et l'accès ne s'obtient 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 d'administration. Pour demander l'accès, contactez votre équipe de compte Mistral ou notre équipe commerciale.

Avant de commencer

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.

Rôles d’espace de travail

Rôles d’espace de travail

Utilisez le champ pluriel role_names pour attribuer les rôles d’espace de travail. Listez les rôles disponibles et leurs UUID avec GET /api/admin/roles. Consultez Gérer les groupes et les rôles pour la liste complète des rôles.

Note

Les champs singuliers role et role_name sont obsolètes. Préférez les champs pluriels roles et role_names.

Lister les espaces de travail

Lister les espaces de travail

L’endpoint accepte les paramètres de requête is_archived, page, page_size et search.

curl "https://api.mistral.ai/v1/admin/workspaces?page=1&page_size=50" \
  -H "x-api-key: $ADMIN_API_KEY"
Créer un espace de travail

Créer un espace de travail

name et admin_user_id sont obligatoires. Les champs description, icon et add_all_org_members sont facultatifs.

curl -X POST https://api.mistral.ai/v1/admin/workspaces \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{
    "name": "MySpace",
    "description": "Small Workspace",
    "icon": "",
    "add_all_org_members": false,
    "admin_user_id": "<USER_UUID>"
  }'

La réponse inclut l’uuid de l’espace de travail.

Mettre à jour un espace de travail

Mettre à jour un espace de travail

curl -X PATCH https://api.mistral.ai/v1/admin/workspaces/<WORKSPACE_UUID> \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"name": "Renamed Workspace", "description": "Updated description"}'
Supprimer un espace de travail

Supprimer un espace de travail

curl -X DELETE https://api.mistral.ai/v1/admin/workspaces/<WORKSPACE_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"
Gérer les membres

Gérer les membres

Ajoutez ou mettez à jour des membres avec un tableau members. Chaque objet doit inclure user_uuid et role_names.

# Add members
curl -X POST https://api.mistral.ai/v1/admin/workspaces/<WORKSPACE_UUID>/add-users \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"members": [{"user_uuid": "<USER_UUID>", "role_names": ["user"]}]}'

# Add or update members (idempotent)
curl -X PATCH https://api.mistral.ai/v1/admin/workspaces/<WORKSPACE_UUID>/users \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"members": [{"user_uuid": "<USER_UUID>", "role_names": ["workspace_admin"]}]}'
Retirer des membres

Retirer des membres

Cette opération retire les utilisateurs listés de l’espace de travail et supprime leurs permissions dans cet espace.

curl -X DELETE https://api.mistral.ai/v1/admin/workspaces/<WORKSPACE_UUID>/remove-users \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"members": [{"user_uuid": "<USER_UUID_1>"}, {"user_uuid": "<USER_UUID_2>"}]}'