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:

  1. Realizas solicitudes usando tu clave API de Administración en el encabezado x-api-key
  2. 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.

RolPermisos
userPuede usar Workbench
developerPuede usar Workbench y gestionar claves API
billingPuede usar Workbench y gestionar detalles de facturación
adminPuede 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.

Invitaciones de la Organización

Puedes invitar usuarios a organizaciones y gestionar esas invitaciones.

Espacios de trabajo

Crea y gestiona espacios de trabajo para organizar tus recursos:

Miembros del Espacio de Trabajo

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

Claves API

Monitorea y gestiona claves API:

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 roles y permisos de miembros
  • Limpia espacios de trabajo no utilizados e invitaciones expiradas
  • Monitorea el uso de claves API y rótalas periódicamente

Preguntas frecuentes