Administration et surveillance

Aperçu 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 par programmation 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 Claude.

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

Comment fonctionne l'API Admin

Lorsque vous utilisez l'API Admin :

Vous faites des requêtes en utilisant votre clé API Admin 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/départ des utilisateurs
Gérer par programmation 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 y a 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.

# 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

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

# 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é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 "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

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 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"
  }'

Accès aux informations de l'organisation

Obtenez des informations sur votre organisation par programmation 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 par programmation à quelle organisation appartient une clé API Admin.

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.

Accès aux rapports d'utilisation et de coût

Pour accéder aux rapports d'utilisation et de coût de votre organisation, utilisez les points de terminaison de l'API d'utilisation et de coût :

Le point de terminaison d'utilisation (/v1/organizations/usage_report/messages) fournit des données d'utilisation détaillées, y compris les comptes de jetons et les métriques de requête, regroupées par diverses dimensions telles que l'espace de travail, l'utilisateur et le modèle.
Le point de terminaison de coût (/v1/organizations/cost_report) fournit des données de coût associées à l'utilisation de votre organisation, vous permettant de suivre les dépenses et d'allouer les coûts par espace de travail ou description.

Ces points de terminaison fournissent des informations détaillées sur l'utilisation de votre organisation et les coûts associés.

Accès aux analyses Claude Code

Pour les organisations utilisant Claude Code, l'API d'analyses Claude Code fournit des métriques de productivité détaillées et des informations d'utilisation :

Le point de terminaison d'analyses Claude Code (/v1/organizations/usage_report/claude_code) fournit des métriques agrégées quotidiennes pour l'utilisation de Claude Code, y compris les sessions, les lignes de code, les commits, les pull requests, les statistiques d'utilisation des outils et les données de coût ventilées par utilisateur et modèle.

Cette API vous permet de suivre la productivité des développeurs, d'analyser l'adoption de Claude Code et de créer des tableaux de bord personnalisés pour votre organisation.

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

Administration et surveillance

Aperçu 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 nécessite un accès spécial

Comment fonctionne l'API Admin

Lorsque vous utilisez l'API Admin :

Vous faites des requêtes en utilisant votre clé API Admin 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/départ des utilisateurs
Gérer par programmation 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 y a 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.

# 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

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

# 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é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 "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

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 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"
  }'

Accès aux informations de l'organisation

Obtenez des informations sur votre organisation par programmation 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 par programmation à quelle organisation appartient une clé API Admin.

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.

Accès aux rapports d'utilisation et de coût

Pour accéder aux rapports d'utilisation et de coût de votre organisation, utilisez les points de terminaison de l'API d'utilisation et de coût :

Le point de terminaison d'utilisation (/v1/organizations/usage_report/messages) fournit des données d'utilisation détaillées, y compris les comptes de jetons et les métriques de requête, regroupées par diverses dimensions telles que l'espace de travail, l'utilisateur et le modèle.
Le point de terminaison de coût (/v1/organizations/cost_report) fournit des données de coût associées à l'utilisation de votre organisation, vous permettant de suivre les dépenses et d'allouer les coûts par espace de travail ou description.

Ces points de terminaison fournissent des informations détaillées sur l'utilisation de votre organisation et les coûts associés.

Accès aux analyses Claude Code

Pour les organisations utilisant Claude Code, l'API d'analyses Claude Code fournit des métriques de productivité détaillées et des informations d'utilisation :

Le point de terminaison d'analyses Claude Code (/v1/organizations/usage_report/claude_code) fournit des métriques agrégées quotidiennes pour l'utilisation de Claude Code, y compris les sessions, les lignes de code, les commits, les pull requests, les statistiques d'utilisation des outils et les données de coût ventilées par utilisateur et modèle.

Cette API vous permet de suivre la productivité des développeurs, d'analyser l'adoption de Claude Code et de créer des tableaux de bord personnalisés pour votre organisation.

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

Comment fonctionne l'API Admin

Rôles et permissions 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

Accès aux rapports d'utilisation et de coût

Accès aux analyses Claude Code

Meilleures pratiques

FAQ

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

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

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

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

Combien de temps durent les invitations d'organisation ?

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

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

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

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

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

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

Comment fonctionne l'API Admin

Rôles et permissions 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

Accès aux rapports d'utilisation et de coût

Accès aux analyses Claude Code

Meilleures pratiques

FAQ

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

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

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

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

Combien de temps durent les invitations d'organisation ?

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

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

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

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

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

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