Admin API

L'Admin API vous permet de gérer de manière programmatique les ressources de votre organisation, notamment 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 Claude Console.



Authentification

Authentifiez-vous avec l'un ou l'autre des identifiants. Les exemples suivants appellent le point de terminaison des informations de l'organisation des deux manières :

OAuth bearer :

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

Un jeton org:admin donne accès à l'ensemble de l'organisation, quel que soit l'espace de travail auquel le profil sous-jacent ou la règle de fédération est lié. Pour en obtenir un, consultez les prérequis dans Gérer WIF avec l'Admin API.

Clé Admin API :

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"



Fonctionnement de l'Admin API

Lorsque vous utilisez l'Admin API :

1. Vous effectuez des requêtes en utilisant l'un des identifiants de la section Authentification
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
   • Les comptes de service, les émetteurs de fédération et les règles de fédération (ces points de terminaison nécessitent un jeton OAuth org:admin ; les clés Admin API ne sont pas acceptées)

Ceci est utile pour :

• Automatiser l'intégration et le 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 autorisations de l'organisation

Il existe cinq rôles au niveau de l'organisation. Consultez plus de détails dans l'article Rôles et autorisations de la console API.

Les propriétaires (owners) et propriétaires principaux (primary owners) de l'organisation disposent de toutes les autorisations admin et peuvent en outre gérer les admins. Toutes les références au rôle admin sur cette page s'appliquent également aux owners et primary owners.



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.

# 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 "content-type: application/json" \
  --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 des organisations et gérer ces invitations.

# Créer une invitation
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[email protected]",
    "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

Pour un guide complet sur les espaces de travail, incluant des exemples pour la Console et l'API, consultez Espaces de travail.



Membres des espaces de travail

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

# 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 "content-type: application/json" \
  --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 du membre
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Retirer 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

Surveillez et gérez les clés API :

# 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 la clé API
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'



Comptes de service

Créez et gérez des comptes de service (svac_...), les identités non humaines au nom desquelles agissent les jetons de Workload Identity Federation. Les clés Admin API ne sont pas acceptées sur les points de terminaison des comptes de service, des émetteurs de fédération ou des règles de fédération ; utilisez un jeton OAuth org:admin. Consultez Gérer WIF avec l'Admin API.



Émetteurs de fédération

Enregistrez les fournisseurs d'identité OIDC (fdis_...) dont les jetons peuvent attester l'identité de charge de travail pour votre organisation. Consultez Gérer WIF avec l'Admin API.



Règles de fédération

Gérez les règles (fdrl_...) qui associent les jetons d'émetteurs aux comptes de service et aux portées. Consultez Gérer WIF avec l'Admin API.



Accéder aux informations de l'organisation

Obtenez des informations sur votre organisation de manière programmatique avec le point de terminaison /v1/organizations/me.

Par exemple :

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Ce point de terminaison est utile pour déterminer de manière programmatique à quelle organisation appartient une clé Admin API.

Pour les détails complets des paramètres et les schémas de réponse, consultez la référence de l'API Organization Info.



Rapports d'utilisation et de coûts

Suivez l'utilisation et les coûts de votre organisation avec l'API Usage and Cost.



Analyses Claude Code

Surveillez la productivité des développeurs et l'adoption de Claude Code avec l'API Claude Code Analytics.



Limites de débit

Consultez les limites de débit configurées pour votre organisation et ses espaces de travail avec l'API Rate Limits.



API Compliance

Récupérez les données d'audit et d'activité de votre organisation avec l'API Compliance. Les clés Admin API peuvent uniquement lire le flux d'activité ; pour un accès complet, consultez Obtenir l'accès à l'API Compliance.



Bonnes pratiques

Pour utiliser efficacement l'Admin API :

• Utilisez des noms et des descriptions explicites 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 autorisations 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

Pour les questions spécifiques aux espaces de travail, consultez la FAQ sur les espaces de travail.