Aperçu de l'API Admin

AdminAdministration

Aperçu de l'Admin API

Apprenez à utiliser l'Admin API pour gérer programmatiquement les ressources de votre organisation, y compris les membres, les espaces de travail et les clés API.

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

L'Admin API 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 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 nécessite une clé Admin API 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 provisionner les clés Admin API via la Claude Console.

Comment fonctionne l'Admin API

Lorsque vous utilisez l'Admin API :

Vous effectuez des requêtes en utilisant votre clé Admin API dans l'en-tête x-api-key
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/suppression 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 au niveau de l'organisation

Il y a cinq rôles au niveau de l'organisation. Voir plus de détails dans l'article Rôles et permissions de la console API.

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 du 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 aux 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": "[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 des espaces de travail, y compris des exemples de Console et d'API, voir Espaces de travail.

Membres de l'espace de travail

Gérez l'accès des utilisateurs à des 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 du 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

Surveillez et gérez 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 la 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"
  }'

Accès aux informations de l'organisation

Obtenez des informations sur votre organisation programmatiquement 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: $ADMIN_API_KEY"

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

Ce point de terminaison est utile pour déterminer programmatiquement à quelle organisation appartient une clé Admin API.

Pour les détails complets des paramètres et les schémas de réponse, voir la référence de l'API d'informations sur l'organisation.

Rapports d'utilisation et de coûts

Suivez l'utilisation et les coûts de votre organisation avec l'API d'utilisation et de coûts.

Analyse de Claude Code

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

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 permissions des membres
Nettoyez les espaces de travail inutilisés et les invitations expirées
Surveillez l'utilisation des clés API et faites tourner les clés périodiquement

FAQ

Pour les questions spécifiques à l'espace de travail, voir la FAQ des espaces de travail.

Was this page helpful?

AdminAdministration

Aperçu de l'Admin API

Apprenez à utiliser l'Admin API pour gérer programmatiquement les ressources de votre organisation, y compris les membres, les espaces de travail et les clés API.

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

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

Comment fonctionne l'Admin API

Lorsque vous utilisez l'Admin API :

Vous effectuez des requêtes en utilisant votre clé Admin API dans l'en-tête x-api-key
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/suppression 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 au niveau de l'organisation

Il y a cinq rôles au niveau de l'organisation. Voir plus de détails dans l'article Rôles et permissions de la console API.

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 du 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 aux 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": "[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 des espaces de travail, y compris des exemples de Console et d'API, voir Espaces de travail.

Membres de l'espace de travail

Gérez l'accès des utilisateurs à des 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 du 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

Surveillez et gérez 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 la 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"
  }'

Accès aux informations de l'organisation

Obtenez des informations sur votre organisation programmatiquement 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: $ADMIN_API_KEY"

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

Ce point de terminaison est utile pour déterminer programmatiquement à quelle organisation appartient une clé Admin API.

Pour les détails complets des paramètres et les schémas de réponse, voir la référence de l'API d'informations sur l'organisation.

Rapports d'utilisation et de coûts

Suivez l'utilisation et les coûts de votre organisation avec l'API d'utilisation et de coûts.

Analyse de Claude Code

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

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 permissions des membres
Nettoyez les espaces de travail inutilisés et les invitations expirées
Surveillez l'utilisation des clés API et faites tourner les clés périodiquement

FAQ

Pour les questions spécifiques à l'espace de travail, voir la FAQ des espaces de travail.

Was this page helpful?

Comment fonctionne l'Admin API

Rôles et permissions au niveau de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres de l'espace de travail

Clés API

Accès aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyse de Claude Code

Bonnes pratiques

FAQ

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

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

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

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

Combien de temps durent les invitations de l'organisation ?

Comment fonctionne l'Admin API

Rôles et permissions au niveau de l'organisation

Concepts clés

Membres de l'organisation

Invitations de l'organisation

Espaces de travail

Membres de l'espace de travail

Clés API

Accès aux informations de l'organisation

Rapports d'utilisation et de coûts

Analyse de Claude Code

Bonnes pratiques

FAQ

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

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

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

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

Combien de temps durent les invitations de l'organisation ?