Vue d’ensemble de l’API Admin
L’API Admin est une fonctionnalité réservée aux plans Enterprise. Elle permet aux administrateurs Organisation et aux ingénieurs solutions d’automatiser la gestion des comptes. Utilisez-la pour provisionner des utilisateurs, gérer les espaces de travail et les groupes, renouveler les clés API, définir des limites de dépenses et de débit, et consulter les données d’utilisation et les journaux d’audit.
L’API Admin est en Preview et disponible avec les plans Enterprise. Les endpoints et les champs peuvent changer pendant la phase de préversion.
Concepts
La documentation Admin concerne principalement la gestion d’une Organisation. Certains clients Enterprise disposent aussi d’un compte Enterprise, qui regroupe plusieurs Organisations lorsqu’ils doivent séparer les groupes d’utilisateurs au-delà de ce que permettent les espaces de travail.
Le Backoffice (backoffice.mistral.ai ↗) gère les comptes Enterprise, leurs Organisations, leurs membres et les clés API Admin de chaque Organisation. Pour comprendre le fonctionnement des comptes Enterprise et du Backoffice, consultez Comptes Enterprise et Backoffice.
Le Backoffice n’est pas le Panneau Admin. Le Panneau Admin (admin.mistral.ai) administre une seule Organisation. Le Backoffice (backoffice.mistral.ai) gère un compte Enterprise et les Organisations qui en dépendent.
Un groupe d’utilisateurs regroupe des utilisateurs pour les gérer ensemble. Par exemple, créez un groupe, ajoutez des membres, puis attribuez le groupe à un espace de travail avec un rôle donné. Consultez Groupes.
Authentification
L’API Admin utilise une clé API Admin dédiée, créée dans le Backoffice et transmise dans l’en-tête x-api-key. Une clé API utilisateur standard ne donne jamais d’accès administrateur. Consultez Authentification et clés API Admin pour les détails.
Fonctionnalités
Utilisez l’API Admin pour gérer :
- Utilisateurs et invitations : consultez Gestion des utilisateurs
- Groupes : consultez Groupes
- Espaces de travail : consultez Votre premier espace de travail
- Clés API : consultez Clés API
- Dépenses et limites de débit : consultez Utilisation et limites
- Utilisation : consultez Métriques d’utilisation avec l’API Admin
- Journaux d’audit : consultez Journaux d’audit
Rôles et permissions
Plusieurs endpoints acceptent les champs de rôle par UUID (roles) ou par nom (role_names). Les endpoints d’attribution aux espaces de travail acceptent workspace_role (UUID) ou workspace_role_name (nom). Lorsque le contrôle d’accès basé sur les rôles (RBAC) est activé, listez les rôles disponibles et leurs UUID avec GET /api/admin/roles.
Les champs de rôle singuliers (role, role_name) sont obsolètes. Utilisez les équivalents pluriels (roles, role_names), qui permettent d’attribuer plusieurs rôles à un utilisateur.
Pour une description complète des rôles, consultez Rôles et permissions.