Utilisation de l'API Admin

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

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

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

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

Comment fonctionne l’API Admin

Lorsque vous utilisez l’API Admin :

1. Vous faites des requêtes en utilisant votre clé API Admin 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

Ceci est utile pour :

• Automatiser l’intégration/départ des utilisateurs
• Gérer de manière programmatique 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 cinq rôles au niveau de l’organisation. Voir plus de détails ici.

Rôle	Permissions
user	Peut utiliser Workbench
claude_code_user	Peut utiliser Workbench et Claude Code
developer	Peut utiliser Workbench et gérer les clés API
billing	Peut utiliser Workbench et gérer les détails de facturation
admin	Peut 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.

Shell

# Lister les membres de l'organisation
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Mettre à jour le rôle d'un membre
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# Supprimer un membre
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Invitations de l’organisation

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

Shell

# Créer une invitation
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[e-mail]",
    "role": "developer"
  }'

# Lister les invitations
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Supprimer une invitation
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Espaces de travail

Créer et gérer les espaces de travail (console) pour organiser vos ressources :

Shell

# Créer un espace de travail
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# Lister les espaces de travail
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Archiver un espace de travail
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Membres de l’espace de travail

Gérer l’accès des utilisateurs aux espaces de travail spécifiques :

Shell

# Ajouter un membre à l'espace de travail
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# Lister les membres de l'espace de travail
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Mettre à jour le rôle d'un membre
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Supprimer un membre de l'espace de travail
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Clés API

Surveiller et gérer les clés API :

Shell

# Lister les clés API
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Mettre à jour une clé API
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Meilleures pratiques

Pour utiliser efficacement l’API Admin :

• Utilisez des noms et descriptions significatifs pour les espaces de travail et les clés API
• Implémentez une gestion d’erreur appropriée 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 effectuez une rotation périodique des clés

FAQ

Quelles permissions sont nécessaires pour utiliser l'API Admin ?

Seuls les membres de l’organisation avec le rôle d’administrateur peuvent utiliser l’API Admin. Ils doivent également avoir une clé API Admin spéciale (commençant par sk-ant-admin).

Puis-je créer de nouvelles clés API via l'API Admin ?

Non, les nouvelles clés API ne peuvent être créées que via la Console Anthropic pour des raisons de sécurité. L’API Admin ne peut que gérer les clés API existantes.

Que se passe-t-il avec les clés API lors de la suppression d'un utilisateur ?

Les clés API persistent dans leur état actuel car elles sont liées à l’Organisation, pas aux utilisateurs individuels.

Les administrateurs d'organisation peuvent-ils être supprimés via l'API ?

Non, les membres de l’organisation avec le rôle d’administrateur ne peuvent pas être supprimés via l’API pour des raisons de sécurité.

Combien de temps durent les invitations d'organisation ?

Les invitations d’organisation expirent après 21 jours. Il n’y a actuellement aucun moyen de modifier cette période d’expiration.

Y a-t-il des limites sur les espaces de travail ?

Oui, vous pouvez avoir un maximum de 100 espaces de travail par Organisation. Les espaces de travail archivés ne comptent pas dans cette limite.

Qu'est-ce que l'Espace de travail par défaut ?

Chaque Organisation a un “Espace de travail par défaut” qui ne peut pas être modifié ou supprimé, et n’a pas d’ID. Cet Espace de travail n’apparaît pas dans les points de terminaison de liste des espaces de travail.

Comment les rôles d'organisation affectent-ils l'accès aux Espaces de travail ?

Les administrateurs d’organisation obtiennent automatiquement le rôle workspace_admin pour tous les espaces de travail. Les membres de facturation d’organisation obtiennent automatiquement le rôle workspace_billing. Les utilisateurs et développeurs d’organisation doivent être ajoutés manuellement à chaque espace de travail.

Quels rôles peuvent être assignés dans les espaces de travail ?

Les utilisateurs et développeurs d’organisation peuvent se voir assigner les rôles workspace_admin, workspace_developer, ou workspace_user. Le rôle workspace_billing ne peut pas être assigné manuellement - il est hérité du fait d’avoir le rôle d’organisation billing.

Les rôles d'espace de travail des membres administrateurs ou de facturation d'organisation peuvent-ils être modifiés ?

Seuls les membres de facturation d’organisation peuvent voir leur rôle d’espace de travail promu au rôle d’administrateur. Sinon, les administrateurs d’organisation et les membres de facturation ne peuvent pas voir leurs rôles d’espace de travail modifiés ou être supprimés des espaces de travail tant qu’ils détiennent ces rôles d’organisation. Leur accès aux espaces de travail doit être modifié en changeant d’abord leur rôle d’organisation.

Que se passe-t-il avec l'accès aux espaces de travail lorsque les rôles d'organisation changent ?

Si un administrateur d’organisation ou un membre de facturation est rétrogradé au rang d’utilisateur ou de développeur, ils perdent l’accès à tous les espaces de travail sauf ceux où ils ont été assignés manuellement des rôles. Lorsque les utilisateurs sont promus aux rôles d’administrateur ou de facturation, ils obtiennent un accès automatique à tous les espaces de travail.