Descripción general de la API de administración
The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
La API de administración te permite gestionar programáticamente los recursos de tu organización, incluyendo miembros de la organización, espacios de trabajo y claves API. Esto proporciona control programático sobre tareas administrativas que de otro modo requerirían configuración manual en la Consola Claude.
La API de administración requiere acceso especial
La API de administración requiere una clave API de administración especial (que comienza con sk-ant-admin...) que difiere de las claves API estándar. Solo los miembros de la organización con el rol de administrador pueden aprovisionar claves API de administración a través de la Consola Claude.
Cómo funciona la API de administración
Cuando usas la API de administración:
- Realizas solicitudes usando tu clave API de administración en el encabezado
x-api-key - La API te permite gestionar:
- Miembros de la organización y sus roles
- Invitaciones de miembros de la organización
- Espacios de trabajo y sus miembros
- Claves API
Esto es útil para:
- Automatizar la incorporación/desvinculación de usuarios
- Gestionar programáticamente el acceso a espacios de trabajo
- Monitorear y gestionar el uso de claves API
Roles y permisos de la organización
Hay cinco roles a nivel de organización. Ve más detalles aquí.
| Rol | Permisos |
|---|---|
| user | Puede usar Workbench |
| claude_code_user | Puede usar Workbench y Claude Code |
| developer | Puede usar Workbench y gestionar claves API |
| billing | Puede usar Workbench y gestionar detalles de facturación |
| admin | Puede hacer todo lo anterior, además de gestionar usuarios |
Conceptos clave
Miembros de la organización
Puedes listar miembros de la organización, actualizar roles de miembros y eliminar miembros.
# Listar miembros de la organización
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Actualizar rol de miembro
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"}'
# Eliminar miembro
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"Invitaciones de la organización
Puedes invitar usuarios a organizaciones y gestionar esas invitaciones.
# Crear invitación
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"
}'
# Listar invitaciones
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Eliminar invitación
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"Espacios de trabajo
Crea y gestiona espacios de trabajo (consola) para organizar tus recursos:
# Crear espacio de trabajo
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"}'
# Listar espacios de trabajo
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"
# Archivar espacio de trabajo
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"Miembros del espacio de trabajo
Gestiona el acceso de usuarios a espacios de trabajo específicos:
# Agregar miembro al espacio de trabajo
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"
}'
# Listar miembros del espacio de trabajo
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"
# Actualizar rol de miembro
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"
}'
# Eliminar miembro del espacio de trabajo
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"Claves API
Monitorea y gestiona claves API:
# Listar claves 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"
# Actualizar clave 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"
}'Acceder a información de la organización
Obtén información sobre tu organización programáticamente con el endpoint /v1/organizations/me.
Por ejemplo:
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"
}Este endpoint es útil para determinar programáticamente a qué organización pertenece una clave API de administración.
Para detalles completos de parámetros y esquemas de respuesta, consulta la referencia de la API de información de la organización.
Acceder a informes de uso y costos
Para acceder a informes de uso y costos para tu organización, usa los endpoints de la API de uso y costos:
- El endpoint de uso (
/v1/organizations/usage_report/messages) proporciona datos detallados de uso, incluyendo conteos de tokens y métricas de solicitudes, agrupados por varias dimensiones como espacio de trabajo, usuario y modelo. - El endpoint de costos (
/v1/organizations/cost_report) proporciona datos de costos asociados con el uso de tu organización, permitiéndote rastrear gastos y asignar costos por espacio de trabajo o descripción.
Estos endpoints proporcionan información detallada sobre el uso de tu organización y los costos asociados.
Acceder a análisis de Claude Code
Para organizaciones que usan Claude Code, la API de análisis de Claude Code proporciona métricas detalladas de productividad e información de uso:
- El endpoint de análisis de Claude Code (
/v1/organizations/usage_report/claude_code) proporciona métricas agregadas diarias para el uso de Claude Code, incluyendo sesiones, líneas de código, commits, pull requests, estadísticas de uso de herramientas y datos de costos desglosados por usuario y modelo.
Esta API te permite rastrear la productividad del desarrollador, analizar la adopción de Claude Code y construir paneles personalizados para tu organización.
Mejores prácticas
Para usar efectivamente la API de administración:
- Usa nombres y descripciones significativos para espacios de trabajo y claves API
- Implementa manejo adecuado de errores para operaciones fallidas
- Audita regularmente roles y permisos de miembros
- Limpia espacios de trabajo no utilizados e invitaciones expiradas
- Monitorea el uso de claves API y rota las claves periódicamente