Les administrateurs Enterprise fédéraux peuvent interroger par programmation la consommation d’ACU et gérer les groupes, la disponibilité des modèles et les limites d’ACU à l’aide d’une API à clé de service. Un SDK Python encapsule chaque endpoint décrit dans cette section.
Les endpoints de gestion des groupes et de plafond d’ACU sont disponibles uniquement dans les déploiements fédéraux multi-tenants auto-hébergés. Ils ne sont pas exposés dans les déploiements commerciaux. Les endpoints d’analyse (/Analytics, /UserPageAnalytics et /CascadeAnalytics) vérifient également le niveau d’accès aux analyses du déploiement ; une Team sans accès aux analyses reçoit permission_denied.
Toutes les requêtes sont des requêtes POST JSON envoyées au serveur d’API de votre déploiement :
Remplacez <your-server> par le domaine de l’API de votre déploiement fédéral.
Chaque requête est authentifiée à l’aide d’une clé de service incluse dans le corps de la requête :
Pour créer une clé de service, connectez-vous au portail fédéral en tant qu’administrateur de la Team, puis accédez à Settings → Clés de service. Créez ensuite une clé avec les autorisations requises par les endpoints que vous prévoyez d’appeler.
Conservez les clés de service en lieu sûr. Ne les exposez jamais dans du code côté client et ne les committez jamais dans des dépôts.
Clés limitées à une Team ou à un groupe
- Les clés limitées à une Team peuvent interroger les données de l’ensemble de la Team et gérer tous les groupes de la Team.
- Les clés limitées à un groupe sont restreintes au groupe qui leur est attribué. Elles peuvent lire le total cumulé d’ACU du groupe et les lignes utilisateur, lister et lire uniquement ce groupe, et lire ou mettre à jour les plafonds d’ACU uniquement pour les membres actuels de ce groupe. Elles ne peuvent pas lire les totaux de l’ensemble de la Team ni les lignes utilisateur, consulter d’autres groupes ou créer des groupes.
Les listes de groupes, de membres de groupes et les lignes d’ACU par utilisateur sont paginées :
page_size — facultatif ; 100 par défaut, 1 000 au maximum. Si vous l’omettez ou transmettez 0, la valeur par défaut est utilisée.next_page_token — renvoyé lorsque d’autres résultats sont disponibles. Transmettez-le comme page_token dans une requête par ailleurs identique (y compris avec le même page_size) pour récupérer la page suivante.
Les jetons de page sont opaques et chiffrés. Ils expirent après 24 heures. Les jetons de consommation d’ACU sont associés à l’endpoint, à la team, au périmètre, à la période, à la sélection de groupes et à la taille de page. Les jetons de liste de groupes et de membres sont associés à l’endpoint, à la team, au périmètre et à la taille de page. Toute modification d’une valeur associée entre deux pages renvoie une erreur invalid_argument.
Les erreurs sont renvoyées au format JSON avec un code et un message :
