Descripción general de la API de administración

Administración

Descripción general de la API de administración

Aprende a usar la API de administración de Anthropic para gestionar programáticamente los recursos de tu organizació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 Claude Console.

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

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/desincorporación de usuarios
Gestionar programáticamente el acceso al espacio 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. Consulta más detalles en el artículo Roles y permisos de la consola API.

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.

Shell

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

Shell

# 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

Para una guía completa sobre espacios de trabajo, incluyendo ejemplos de consola y API, consulta Espacios de trabajo.

Miembros del espacio de trabajo

Gestiona el acceso de usuarios a espacios de trabajo específicos:

Shell

# 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 del 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:

Shell

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

Acceso a la información de la organización

Obtén información sobre tu organización programáticamente con el punto final /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 punto final es útil para determinar programáticamente a qué organización pertenece una clave API de administración.

Para obtener detalles completos de parámetros y esquemas de respuesta, consulta la referencia de la API de información de la organización.

Informes de uso y costos

Realiza un seguimiento del uso y los costos de tu organización con la API de uso y costos.

Análisis de Claude Code

Monitorea la productividad de los desarrolladores y la adopción de Claude Code con la API de análisis de Claude Code.

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 de errores adecuado para operaciones fallidas
Audita regularmente los roles y permisos de los miembros
Limpia espacios de trabajo no utilizados e invitaciones expiradas
Monitorea el uso de claves API y rota las claves periódicamente

Preguntas frecuentes

Para preguntas específicas del espacio de trabajo, consulta las Preguntas frecuentes sobre espacios de trabajo.

Was this page helpful?

Administración

Descripción general de la API de administración

Aprende a usar la API de administración de Anthropic para gestionar programáticamente los recursos de tu organizació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 requiere acceso especial

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/desincorporación de usuarios
Gestionar programáticamente el acceso al espacio 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. Consulta más detalles en el artículo Roles y permisos de la consola API.

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.

Shell

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

Shell

# 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

Para una guía completa sobre espacios de trabajo, incluyendo ejemplos de consola y API, consulta Espacios de trabajo.

Miembros del espacio de trabajo

Gestiona el acceso de usuarios a espacios de trabajo específicos:

Shell

# 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 del 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:

Shell

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

Acceso a la información de la organización

Obtén información sobre tu organización programáticamente con el punto final /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 punto final es útil para determinar programáticamente a qué organización pertenece una clave API de administración.

Para obtener detalles completos de parámetros y esquemas de respuesta, consulta la referencia de la API de información de la organización.

Informes de uso y costos

Realiza un seguimiento del uso y los costos de tu organización con la API de uso y costos.

Análisis de Claude Code

Monitorea la productividad de los desarrolladores y la adopción de Claude Code con la API de análisis de Claude Code.

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 de errores adecuado para operaciones fallidas
Audita regularmente los roles y permisos de los miembros
Limpia espacios de trabajo no utilizados e invitaciones expiradas
Monitorea el uso de claves API y rota las claves periódicamente

Preguntas frecuentes

Para preguntas específicas del espacio de trabajo, consulta las Preguntas frecuentes sobre espacios de trabajo.

Was this page helpful?

Cómo funciona la API de administración

Roles y permisos de la organización

Conceptos clave

Miembros de la organización

Invitaciones de la organización

Espacios de trabajo

Miembros del espacio de trabajo

Claves API

Acceso a la información de la organización

Informes de uso y costos

Análisis de Claude Code

Mejores prácticas

Preguntas frecuentes

¿Qué permisos se necesitan para usar la API de administración?

¿Puedo crear nuevas claves API a través de la API de administración?

¿Qué sucede con las claves API al eliminar un usuario?

¿Se pueden eliminar administradores de la organización a través de la API?

¿Cuánto tiempo duran las invitaciones de la organización?

Cómo funciona la API de administración

Roles y permisos de la organización

Conceptos clave

Miembros de la organización

Invitaciones de la organización

Espacios de trabajo

Miembros del espacio de trabajo

Claves API

Acceso a la información de la organización

Informes de uso y costos

Análisis de Claude Code

Mejores prácticas

Preguntas frecuentes

¿Qué permisos se necesitan para usar la API de administración?

¿Puedo crear nuevas claves API a través de la API de administración?

¿Qué sucede con las claves API al eliminar un usuario?

¿Se pueden eliminar administradores de la organización a través de la API?

¿Cuánto tiempo duran las invitaciones de la organización?