AdministrationOrganisation

Admin API

Gérez les membres de l'organisation, les espaces de travail, les invitations et les clés API de manière programmatique avec l'Admin API, en utilisant une clé Admin API ou un jeton OAuth org:admin.

L'API Admin n'est pas disponible pour les comptes individuels. Pour collaborer avec vos coéquipiers et ajouter des membres, configurez votre organisation dans Console → Settings → Organization.

L'Admin API 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 Claude Console.

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

L'Admin API accepte deux identifiants :

Une clé Admin API (commençant par sk-ant-admin...) envoyée dans l'en-tête x-api-key. Seuls les membres de l'organisation ayant le rôle admin peuvent en provisionner une. Consultez Créer une clé Admin API.
Un jeton bearer OAuth avec la portée org:admin envoyé dans l'en-tête authorization: Bearer. Seuls les membres ayant le rôle admin, owner ou primary owner peuvent en obtenir un. Consultez Obtenir un jeton bearer OAuth.

Claude Enterprise : Les organisations Claude Enterprise (claude.ai) utilisent également l'Admin API, avec une clé API à portée limitée créée dans claude.ai. Parmi les points de terminaison de cette page, seuls les membres et les invitations leur sont disponibles (en bêta), aux côtés des points de terminaison réservés à Claude Enterprise : les groupes et les lectures de rôles personnalisés (bêta), et les limites de dépenses. Consultez Gestion des utilisateurs pour Claude Enterprise.

Claude Platform sur AWS : La majeure partie de l'Admin API n'est pas disponible sur Claude Platform sur AWS. Les points de terminaison d'espace de travail (création, obtention, liste, mise à jour et archivage sur /v1/organizations/workspaces) sont disponibles. Les autres points de terminaison, y compris les membres de l'organisation, les membres d'espace de travail, les invitations, les clés API, les rapports d'utilisation, les rapports de coûts et les rapports de limite de débit, ne sont pas disponibles. Consultez Claude Platform sur AWS pour plus de détails.

Authentification

Authentifiez-vous avec l'un ou l'autre des identifiants. Une clé Admin API couvre la plupart des points de terminaison ; les points de terminaison de compte de service, d'émetteur de fédération et de règle de fédération n'acceptent qu'un jeton OAuth org:admin. Les exemples suivants appellent le point de terminaison d'informations sur l'organisation des deux manières.

Jeton bearer OAuth

Connectez-vous avec la CLI ant sous un profil dédié, en demandant la portée org:admin (consultez Accès admin), puis exportez le jeton bearer. Un profil dédié évite que vos commandes habituelles s'exécutent avec un accès élevé :

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)

Les jetons interactifs ont une durée de vie courte ; si les requêtes commencent à renvoyer des erreurs 401, réexécutez la commande export, qui actualise le jeton automatiquement.

Appelez l'Admin API avec le jeton exporté :

cURL

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 accorde l'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 la CI et les autres charges de travail non interactives, générez le jeton avec Workload Identity Federation au lieu de vous connecter de manière interactive. Consultez Gérer WIF avec l'Admin API.

Clé Admin API

Pour créer une clé Admin API pour votre type d'organisation, consultez Créer une clé Admin API.

cURL

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"

Comment fonctionne l'Admin API

Lorsque vous utilisez l'Admin API :

Vous effectuez des requêtes en utilisant l'un ou l'autre des identifiants de la section Authentification
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/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.

Rôle	Autorisations
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

Les owners et primary owners de l'organisation disposent de toutes les autorisations admin et peuvent en plus 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.

cURL

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

cURL

# 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, y compris des exemples pour la Console et l'API, consultez Espaces de travail.

Membres d'espace de travail

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

cURL

# 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 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 "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. Chaque clé dans la réponse inclut son horodatage expires_at (null pour les clés sans expiration) :

cURL

# 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 Workload Identity Federation. Les clés Admin API ne sont pas acceptées sur les points de terminaison de compte de service, d'émetteur de fédération ou de règle 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'émetteur 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

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 ne peuvent lire que le flux d'activité ; pour un accès complet, consultez Configurer l'API Compliance.

Bonnes pratiques

Pour utiliser efficacement l'Admin API :

Utilisez des noms et des 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 les autorisations des membres
Nettoyez les espaces de travail inutilisés et les invitations expirées
Surveillez l'utilisation des clés API, auditez le expires_at de chaque clé 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.

Was this page helpful?

AdministrationOrganisation

Admin API

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

L'Admin API accepte deux identifiants :

Une clé Admin API (commençant par sk-ant-admin...) envoyée dans l'en-tête x-api-key. Seuls les membres de l'organisation ayant le rôle admin peuvent en provisionner une. Consultez Créer une clé Admin API.
Un jeton bearer OAuth avec la portée org:admin envoyé dans l'en-tête authorization: Bearer. Seuls les membres ayant le rôle admin, owner ou primary owner peuvent en obtenir un. Consultez Obtenir un jeton bearer OAuth.

Authentification

Jeton bearer OAuth

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)

Les jetons interactifs ont une durée de vie courte ; si les requêtes commencent à renvoyer des erreurs 401, réexécutez la commande export, qui actualise le jeton automatiquement.

Appelez l'Admin API avec le jeton exporté :

cURL

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 accorde l'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é.

Clé Admin API

Pour créer une clé Admin API pour votre type d'organisation, consultez Créer une clé Admin API.

cURL

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"

Comment fonctionne l'Admin API

Lorsque vous utilisez l'Admin API :

Vous effectuez des requêtes en utilisant l'un ou l'autre des identifiants de la section Authentification
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/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.

Rôle	Autorisations
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.

cURL

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

cURL

# 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, y compris des exemples pour la Console et l'API, consultez Espaces de travail.

Membres d'espace de travail

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

cURL

# 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 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 "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. Chaque clé dans la réponse inclut son horodatage expires_at (null pour les clés sans expiration) :

cURL

# 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

É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'émetteur 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

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

Bonnes pratiques

Pour utiliser efficacement l'Admin API :

Utilisez des noms et des 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 les autorisations des membres
Nettoyez les espaces de travail inutilisés et les invitations expirées
Surveillez l'utilisation des clés API, auditez le expires_at de chaque clé 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.

Was this page helpful?

Authentification

Jeton bearer OAuth

Clé Admin API

Comment fonctionne l'Admin API

Rôles et autorisations de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres d'espace de travail

Clés API

Comptes de service

Émetteurs de fédération

Règles de fédération

Accéder aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyses Claude Code

Limites de débit

API Compliance

Bonnes pratiques

FAQ

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

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

Qu'advient-il des clés API lors de la suppression d'un utilisateur ?

Les admins de l'organisation peuvent-ils être supprimés via l'API ?

Combien de temps durent les invitations de l'organisation ?

Authentification

Jeton bearer OAuth

Clé Admin API

Comment fonctionne l'Admin API

Rôles et autorisations de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres d'espace de travail

Clés API

Comptes de service

Émetteurs de fédération

Règles de fédération

Accéder aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyses Claude Code

Limites de débit

API Compliance

Bonnes pratiques

FAQ

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

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

Qu'advient-il des clés API lors de la suppression d'un utilisateur ?

Les admins de l'organisation peuvent-ils être supprimés via l'API ?

Combien de temps durent les invitations de l'organisation ?

Authentification

Jeton bearer OAuth

Clé Admin API

Comment fonctionne l'Admin API

Rôles et autorisations de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres d'espace de travail

Clés API

Comptes de service

Émetteurs de fédération

Règles de fédération

Accéder aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyses Claude Code

Limites de débit

API Compliance

Bonnes pratiques

FAQ

Authentification

Jeton bearer OAuth

Clé Admin API

Comment fonctionne l'Admin API

Rôles et autorisations de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres d'espace de travail

Clés API

Comptes de service

Émetteurs de fédération

Règles de fédération

Accéder aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyses Claude Code

Limites de débit

API Compliance

Bonnes pratiques

FAQ