L’API d’Administration vous permet de gérer programmatiquement les ressources de votre organisation, y compris les membres de l’organisation, les espaces de travail et les clés API. Cela offre un contrôle programmatique sur les tâches administratives qui nécessiteraient autrement une configuration manuelle dans la Console Anthropic.

L’API d’Administration nécessite un accès spécial

L’API d’Administration nécessite une clé API d’administration spéciale (commençant par sk-ant-admin...) qui diffère des clés API standard. Seuls les membres de l’organisation ayant le rôle d’administrateur peuvent fournir des clés API d’administration via la Console Anthropic.

Comment fonctionne l’API d’Administration

Lorsque vous utilisez l’API d’Administration :

  1. Vous effectuez des requêtes en utilisant votre clé API d’administration dans l’en-tête x-api-key
  2. L’API vous permet de gérer :
    • Les membres de l’organisation et leurs rôles
    • Les invitations des membres de l’organisation
    • Les espaces de travail et leurs membres
    • Les clés API

Cela est utile pour :

  • Automatiser l’intégration/la désactivation des utilisateurs
  • Gérer programmatiquement l’accès aux espaces de travail
  • Surveiller et gérer l’utilisation des clés API

Rôles et permissions de l’organisation

Il existe quatre rôles au niveau de l’organisation.

RôlePermissions
userPeut utiliser Workbench
developerPeut utiliser Workbench et gérer les clés API
billingPeut utiliser Workbench et gérer les détails de facturation
adminPeut faire tout ce qui précède, plus gérer les utilisateurs

Concepts clés

Membres de l’Organisation

Vous pouvez lister les membres de l’organisation, mettre à jour les rôles des membres et supprimer des membres.

Invitations de l’Organisation

Vous pouvez inviter des utilisateurs dans les organisations et gérer ces invitations.

Espaces de travail

Créez et gérez des espaces de travail pour organiser vos ressources :

Membres des Espaces de Travail

Gérez l’accès des utilisateurs à des espaces de travail spécifiques :

Clés API

Surveillez et gérez les clés API :

Meilleures pratiques

Pour utiliser efficacement l’API d’Administration :

  • Utilisez des noms et descriptions significatifs pour les espaces de travail et les clés API
  • Implémentez une gestion appropriée des erreurs pour les opérations échouées
  • Auditez régulièrement les rôles et permissions des membres
  • Nettoyez les espaces de travail inutilisés et les invitations expirées
  • Surveillez l’utilisation des clés API et faites-les tourner périodiquement

FAQ