AdministraciónOrganización

Admin API

La Admin API no está disponible para cuentas individuales. Para colaborar con compañeros de equipo y agregar miembros, configura tu organización en Console → Settings → Organization.

La Admin API te permite gestionar de forma programática los recursos de tu organización, incluidos los miembros de la organización, los espacios de trabajo y las claves de API. Esto proporciona control programático sobre tareas administrativas que, de otro modo, requerirían configuración manual en la Claude Console.

La Admin API requiere acceso especial

La Admin API requiere una clave de Admin API especial (que comienza con sk-ant-admin...) que difiere de las claves de API estándar. Solo los miembros de la organización con el rol de administrador pueden aprovisionar claves de Admin API a través de la Claude Console.

Claude Platform en AWS: La mayor parte de la Admin API no está disponible en Claude Platform en AWS. Los endpoints de espacios de trabajo (crear, obtener, listar, actualizar y archivar en /v1/organizations/workspaces) están disponibles. Otros endpoints, incluidos los de miembros de la organización, miembros de espacios de trabajo, invitaciones, claves de API, informes de uso, informes de costos e informes de límites de velocidad, no están disponibles. Consulta Claude Platform en AWS para obtener más detalles.

Cómo funciona la Admin API

Cuando usas la Admin API:

Realizas solicitudes usando tu clave de Admin API 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 de API

Esto es útil para:

Automatizar la incorporación y desvinculación de usuarios
Gestionar de forma programática el acceso a espacios de trabajo
Monitorear y gestionar el uso de claves de API

Roles y permisos de la organización

Existen cinco roles a nivel de organización. Consulta más detalles en el artículo Roles y permisos de la consola de API.

Rol	Permisos
user	Puede usar Workbench
claude_code_user	Puede usar Workbench y Claude Code
developer	Puede usar Workbench y gestionar claves de 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

# 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 "content-type: application/json" \
  --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.

cURL

# Crear invitación
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --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 obtener una guía completa sobre espacios de trabajo, incluidos ejemplos de la consola y la API, consulta Espacios de trabajo.

Miembros de espacios de trabajo

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

cURL

# 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 "content-type: application/json" \
  --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 "content-type: application/json" \
  --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 de API

Monitorea y gestiona claves de API:

cURL

# Listar claves de 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 de API
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Acceder a la información de la organización

Obtén información sobre tu organización de forma programática con el endpoint /v1/organizations/me.

Por ejemplo:

cURL

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

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

Este endpoint es útil para determinar de forma programática a qué organización pertenece una clave de Admin API.

Para obtener detalles completos de los 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.

Analíticas de Claude Code

Monitorea la productividad de los desarrolladores y la adopción de Claude Code con la API de analíticas de Claude Code.

Límites de velocidad

Lee los límites de velocidad configurados para tu organización y sus espacios de trabajo con la API de límites de velocidad.

API de cumplimiento

Recupera datos de auditoría y actividad de tu organización con la API de cumplimiento. Las claves de Admin API solo pueden leer el feed de actividad; para obtener acceso completo, consulta Obtener acceso a la API de cumplimiento.

Mejores prácticas

Para usar la Admin API de manera efectiva:

Usa nombres y descripciones significativos para los espacios de trabajo y las claves de API
Implementa un manejo adecuado de errores para operaciones fallidas
Audita regularmente los roles y permisos de los miembros
Elimina los espacios de trabajo no utilizados y las invitaciones expiradas
Monitorea el uso de las claves de API y rótalas periódicamente

Preguntas frecuentes

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

Was this page helpful?

AdministraciónOrganización

Admin API

La Admin API no está disponible para cuentas individuales. Para colaborar con compañeros de equipo y agregar miembros, configura tu organización en Console → Settings → Organization.

La Admin API requiere acceso especial

Cómo funciona la Admin API

Cuando usas la Admin API:

Realizas solicitudes usando tu clave de Admin API 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 de API

Esto es útil para:

Automatizar la incorporación y desvinculación de usuarios
Gestionar de forma programática el acceso a espacios de trabajo
Monitorear y gestionar el uso de claves de API

Roles y permisos de la organización

Existen cinco roles a nivel de organización. Consulta más detalles en el artículo Roles y permisos de la consola de API.

Rol	Permisos
user	Puede usar Workbench
claude_code_user	Puede usar Workbench y Claude Code
developer	Puede usar Workbench y gestionar claves de 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

# 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 "content-type: application/json" \
  --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.

cURL

# Crear invitación
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --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 obtener una guía completa sobre espacios de trabajo, incluidos ejemplos de la consola y la API, consulta Espacios de trabajo.

Miembros de espacios de trabajo

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

cURL

# 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 "content-type: application/json" \
  --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 "content-type: application/json" \
  --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 de API

Monitorea y gestiona claves de API:

cURL

# Listar claves de 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 de API
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Acceder a la información de la organización

Obtén información sobre tu organización de forma programática con el endpoint /v1/organizations/me.

Por ejemplo:

cURL

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

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

Este endpoint es útil para determinar de forma programática a qué organización pertenece una clave de Admin API.

Para obtener detalles completos de los 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.

Analíticas de Claude Code

Monitorea la productividad de los desarrolladores y la adopción de Claude Code con la API de analíticas de Claude Code.

Límites de velocidad

Lee los límites de velocidad configurados para tu organización y sus espacios de trabajo con la API de límites de velocidad.

API de cumplimiento

Mejores prácticas

Para usar la Admin API de manera efectiva:

Usa nombres y descripciones significativos para los espacios de trabajo y las claves de API
Implementa un manejo adecuado de errores para operaciones fallidas
Audita regularmente los roles y permisos de los miembros
Elimina los espacios de trabajo no utilizados y las invitaciones expiradas
Monitorea el uso de las claves de API y rótalas periódicamente

Preguntas frecuentes

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

Was this page helpful?

Cómo funciona la Admin API

Roles y permisos de la organización

Conceptos clave

Miembros de la organización

Invitaciones de la organización

Espacios de trabajo

Miembros de espacios de trabajo

Claves de API

Acceder a la información de la organización

Informes de uso y costos

Analíticas de Claude Code

Límites de velocidad

API de cumplimiento

Mejores prácticas

Preguntas frecuentes

¿Qué permisos se necesitan para usar la Admin API?

¿Puedo crear nuevas claves de API a través de la Admin API?

¿Qué sucede con las claves de 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 Admin API

Roles y permisos de la organización

Conceptos clave

Miembros de la organización

Invitaciones de la organización

Espacios de trabajo

Miembros de espacios de trabajo

Claves de API

Acceder a la información de la organización

Informes de uso y costos

Analíticas de Claude Code

Límites de velocidad

API de cumplimiento

Mejores prácticas

Preguntas frecuentes

¿Qué permisos se necesitan para usar la Admin API?

¿Puedo crear nuevas claves de API a través de la Admin API?

¿Qué sucede con las claves de 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?