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 de Anthropic.
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 rol de administrador pueden provisionar claves API de Administración a través de la Consola de Anthropic.
Cómo funciona la API de Administración
Cuando utilizas 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 a 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 cuatro roles a nivel de organización.
| Rol | Permisos |
|---|
| user | Puede usar Workbench |
| 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.
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
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"}'
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.
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": "newuser@domain.com",
"role": "developer"
}'
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
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 para organizar tus recursos:
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"}'
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"
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:
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"
}'
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"
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"
}'
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:
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"
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"
}'
Mejores prácticas
Para usar efectivamente la API de Administración:
- Usa nombres y descripciones significativos para espacios de trabajo y claves API
- Implementa un manejo adecuado de errores para operaciones fallidas
- Audita regularmente los roles y permisos de los miembros
- Limpia los espacios de trabajo no utilizados e invitaciones expiradas
- Monitorea el uso de claves API y rótalas periódicamente
Preguntas frecuentes
