Provisionnement des utilisateurs avec l’API Admin

Ce guide explique comment provisionner des utilisateurs avec l’API Admin : créer plusieurs utilisateurs en une seule requête, les organiser dans un groupe d’utilisateurs et donner au groupe accès à un espace de travail. Il couvre aussi la mise à jour des utilisateurs et leur retrait d’un espace de travail.

Avant de commencer

Avant de commencer

Vous avez besoin d’une clé API Admin créée dans le Backoffice. Chaque requête utilise l’URL de base https://console.mistral.ai/api/admin et l’en-tête x-api-key. Consultez Authentification de l’API Admin.

Créer plusieurs utilisateurs

Créer plusieurs utilisateurs

Envoyez un tableau d’utilisateurs pour les créer dans une seule requête. Chaque objet doit inclure un rôle, une adresse e-mail et un nom.

curl -X POST https://console.mistral.ai/api/admin/users \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '[
    {"role_names": ["organization_admin"], "email": "ada@example.com", "first_name": "Ada", "last_name": "Lovelace"},
    {"role_names": ["member"], "email": "alan@example.com", "first_name": "Alan", "last_name": "Turing"}
  ]'

La réponse associe chaque adresse e-mail à l’identifiant de l’utilisateur créé. Les utilisateurs créés se connectent en saisissant leur adresse e-mail et en suivant la procédure de récupération du compte.

Note

Les champs de rôle singuliers (role, role_name) sont obsolètes. Utilisez les champs pluriels roles ou role_names. Listez les rôles disponibles et leurs UUID avec GET /api/admin/roles. Consultez Rôles et permissions.

Inviter des utilisateurs par e-mail

Inviter des utilisateurs par e-mail

Au lieu de créer les utilisateurs directement, vous pouvez envoyer des invitations par e-mail. Les destinataires acceptent l’invitation pour rejoindre l’Organisation. Séparez les adresses par des virgules pour inviter plusieurs personnes à la fois.

curl -X POST https://console.mistral.ai/api/admin/users-invite \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"email": "grace@example.com,katherine@example.com", "role_names": ["member"]}'

Listez ou supprimez les invitations en attente :

# Lister les invitations
curl https://console.mistral.ai/api/admin/users-invite \
  -H "x-api-key: $ADMIN_API_KEY"

# Supprimer une invitation par UUID
curl -X DELETE https://console.mistral.ai/api/admin/users-invite/<INVITATION_UUID> \
  -H "x-api-key: $ADMIN_API_KEY"
Regrouper des utilisateurs

Regrouper des utilisateurs

Un groupe d’utilisateurs vous permet de gérer plusieurs utilisateurs et de leur attribuer les mêmes accès. Créez le 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. Ajoutez des membres à l’aide de leurs identifiants utilisateur :

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>"]}'

Pour en savoir plus sur les groupes, consultez Groupes d’utilisateurs.

Attribuer un groupe à un espace de travail

Attribuer un groupe à un espace de travail

Créez un espace de travail, éventuellement avec un utilisateur comme administrateur :

curl -X POST https://console.mistral.ai/api/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. Ajoutez tous les membres du groupe à l’espace de travail avec un rôle donné :

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"
  }'
Gérer le cycle de vie des utilisateurs

Gérer le cycle de vie des utilisateurs

Mettez à jour les rôles ou les abonnements d’un utilisateur :

curl -X PATCH https://console.mistral.ai/api/admin/users/<USER_UUID> \
  -H "Content-Type: application/json" \
  -H "x-api-key: $ADMIN_API_KEY" \
  -d '{"role_names": ["member"], "subscription_types": ["CHAT", "MISTRAL_CODE"]}'

Retirez des utilisateurs d’un espace de travail. Cette opération supprime toutes leurs permissions dans cet espace de travail :

curl -X DELETE https://console.mistral.ai/api/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>"}]}'
Étapes suivantes

Étapes suivantes