Claude Platform Docs
AdministraciónOrganización

Admin API

Administra miembros de la organización, espacios de trabajo, invitaciones y claves de API de forma programática con la Admin API, usando una clave de Admin API, un token OAuth org:admin, o una clave personal o de cuenta de servicio.

La Admin API te permite administrar los miembros, espacios de trabajo, invitaciones y claves de API de tu organización de forma programática en lugar de hacerlo manualmente en la Claude Console.

Disponibilidad

La Admin API está disponible para las organizaciones de Claude Console y Claude Enterprise. No está disponible para las organizaciones con el plan Team de claude.ai ni para las cuentas individuales de Console. Una cuenta individual de Console primero debe configurar una organización en la página Organización (platform.claude.com/settings/organization) en la Claude Console. Consulta Crear una clave de Admin API para saber dónde crea su clave cada tipo de organización.

Las organizaciones de Claude Enterprise (claude.ai) llaman a la Admin API con una clave de API con alcance limitado creada en claude.ai. De esta página, solo los endpoints de miembros e invitaciones se aplican a ellas. También pueden llamar a la API de análisis de uso y costos, que está en beta y requiere una clave con el alcance read:analytics. También obtienen endpoints exclusivos de Enterprise: lecturas de grupos y roles personalizados, y límites de gasto. La API de plugins, también exclusiva de Enterprise, está en beta. También lo está la API de Claude Tag. Consulta Administración de usuarios.

En Claude Platform on AWS, solo están disponibles estos endpoints de la Admin API:

  • Los endpoints de espacios de trabajo: crear, obtener, listar, actualizar y archivar en /v1/organizations/workspaces.
  • Los endpoints de claves externas, para CMEK: registrar, obtener, listar, actualizar y eliminar en /v1/organizations/external_keys. No hay un endpoint de validación, porque las claves se validan cuando se adjuntan a un espacio de trabajo.
  • Los endpoints de destinos de telemetría.
  • Los endpoints de la API de análisis de uso y costos: /v1/organizations/analytics/usage y /v1/organizations/analytics/cost.

Los miembros de la organización, los miembros de espacios de trabajo, las invitaciones, las claves de API, la API de uso y costos heredada y los informes de límite de velocidad no están disponibles en Claude Platform on AWS.

Autenticación

La Admin API acepta cualquiera de estas tres credenciales:

  • Una clave de Admin API (que comienza con sk-ant-admin...) enviada en el encabezado x-api-key. Solo los miembros de la organización con el rol admin pueden aprovisionar una. Consulta Crear una clave de Admin API.
  • Un token bearer de OAuth con el alcance org:admin enviado en el encabezado authorization: Bearer. Solo los miembros con el rol de administrador, propietario o propietario principal pueden obtener uno. Consulta Obtener un token bearer de OAuth.
  • Una clave personal o clave de cuenta de servicio que no esté limitada a un espacio de trabajo específico, enviada en el encabezado x-api-key. La clave tiene los mismos permisos que la cuenta vinculada. Consulta Tipos de claves.

Una clave de Admin API cubre la mayoría de los endpoints. Los endpoints de cuentas de servicio, emisores de federación y reglas de federación aceptan solo un token OAuth org:admin. Envía una clave personal o una clave de cuenta de servicio en el encabezado x-api-key, como lo harías con una clave de Admin API. Los siguientes ejemplos llaman al endpoint de información de la organización con un token OAuth y con una clave de Admin API.

El SDK expone los endpoints de esta página bajo client.organization, y la CLI ant bajo ant organization. Los ejemplos de esta página usan el cliente predeterminado, que lee una clave de Admin API de ANTHROPIC_API_KEY o un token de portador OAuth de ANTHROPIC_AUTH_TOKEN. Los comentarios de cada ejemplo de listado indican si obtiene más páginas o lee solo la primera. Para conocer los parámetros y respuestas de cada endpoint, consulta la referencia de la Admin API.

Token bearer de OAuth

Inicia sesión con la CLI ant bajo un perfil dedicado con el alcance org:admin (consulta Acceso de administrador), luego exporta el token bearer. --profile admin almacena la credencial org:admin bajo su propio perfil y lo convierte en el perfil activo de la CLI. La variable exportada se aplica a cada llamada del SDK y de la CLI en ese shell. Usa un shell que reserves para administración, elimina la variable cuando termines y vuelve a cambiar la CLI con ant profile activate default:

CLI
ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_AUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token)

Los tokens interactivos son de corta duración. Si las solicitudes comienzan a devolver 401, vuelve a ejecutar el comando export para actualizar el token.

El SDK y la CLI ant leen ANTHROPIC_AUTH_TOKEN automáticamente. Deja ANTHROPIC_API_KEY sin definir en la misma shell para que envíen el token de portador. Las cargas de trabajo automatizadas omiten el inicio de sesión: se autentican mediante Workload Identity Federation, y el SDK y la CLI realizan el intercambio de tokens a partir de las variables de entorno de federación. Consulta Inicializa un workload para administrar WIF.

Llama a la Admin API con el token exportado:

client = anthropic.Anthropic()

organization = client.organization.retrieve()

print(f"id: {organization.id}")
print(f"name: {organization.name}")

Un token org:admin otorga acceso a toda la organización, independientemente del espacio de trabajo al que esté vinculado el perfil subyacente o la regla de federación.

Para CI y otras cargas de trabajo no interactivas, genera el token con Workload Identity Federation en lugar de iniciar sesión de forma interactiva. Consulta Administrar WIF con la Admin API.

Clave de Admin API

Para crear una clave de Admin API para tu tipo de organización, consulta Crear una clave de Admin API.

client = anthropic.Anthropic()

organization = client.organization.retrieve()

print(f"id: {organization.id}")
print(f"name: {organization.name}")

Cómo funciona la Admin API

Autentícate con cualquier credencial de Autenticación, luego administra los siguientes recursos:

  • Miembros de la organización y sus roles
  • Invitaciones de la organización
  • Espacios de trabajo y sus miembros
  • Claves de API
  • Cuentas de servicio, emisores de federación y reglas de federación (solo token OAuth org:admin)

Los usos comunes incluyen automatizar la incorporación y la baja de usuarios, administrar el acceso a espacios de trabajo y auditar claves de API.

Roles y permisos de la organización

Hay cinco roles a nivel de organización. Para más detalles, consulta Roles y permisos de la API Console.

RolPermisos
userPuede usar el playground
claude_code_userPuede usar el playground y Claude Code
developerPuede usar el playground y administrar claves de API
billingPuede usar el playground y administrar detalles de facturación
adminPuede hacer todo lo anterior, además de administrar usuarios

Los propietarios y propietarios principales de la organización tienen todos los permisos de administrador y también pueden administrar a los administradores. Todas las referencias al rol de administrador en esta página también se aplican a los propietarios y propietarios principales.

Conceptos clave

Miembros de la organización

Lista los miembros de la organizaciónVista previa disponible con enlaces a la referencia de la API — presiona Tab hasta que el foco entre a la tarjeta y Escape para volver., actualiza sus roles y elimínalos.

Lista los miembros de tu organización:

client = anthropic.Anthropic()

users = client.organization.users.list(limit=10)

# Obtiene automáticamente más páginas según sea necesario, así que `limit` define el tamaño de página, no el total.
for user in users:
    print(f"{user.id}: {user.email} ({user.role})")

Actualiza el rol de un miembro:

client = anthropic.Anthropic()

user = client.organization.users.update(
    "user_01WxYzAbCdEfGhJkMnPqRsTu", role="developer"
)

print(f"id: {user.id}")
print(f"role: {user.role}")

Elimina un miembro de la organización:

client = anthropic.Anthropic()

removed_user = client.organization.users.remove("user_01WxYzAbCdEfGhJkMnPqRsTu")

print(f"id: {removed_user.id}")

Invitaciones de la organización

Invita a usuarios a tu organización y administra las invitacionesVista previa disponible con enlaces a la referencia de la API — presiona Tab hasta que el foco entre a la tarjeta y Escape para volver. pendientes.

Invita a un usuario a tu organización:

client = anthropic.Anthropic()

invite = client.organization.invites.create(email="user@example.com", role="developer")

print(f"id: {invite.id}")
print(f"email: {invite.email}")
print(f"status: {invite.status}")
print(f"expires_at: {invite.expires_at}")

Lista las invitaciones pendientes, aceptadas y vencidas:

client = anthropic.Anthropic()

invites = client.organization.invites.list(limit=10)

# Obtiene automáticamente más páginas según sea necesario, así que `limit` define el tamaño de página, no el total.
for invite in invites:
    print(f"{invite.id}: {invite.email} ({invite.status})")

Elimina una invitación:

client = anthropic.Anthropic()

deleted_invite = client.organization.invites.delete("invite_015gWxHNr6h6TdRPZTmuCGnn")

print(f"id: {deleted_invite.id}")

Espacios de trabajo

Consulta Espacios de trabajo para ver ejemplos de la Console y la API.

Miembros de espacios de trabajo

Administra el acceso de los usuarios a espacios de trabajo específicosVista previa disponible con enlaces a la referencia de la API — presiona Tab hasta que el foco entre a la tarjeta y Escape para volver..

Agrega un miembro a un espacio de trabajo:

client = anthropic.Anthropic()

member = client.organization.workspaces.members.add(
    "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
    user_id="user_01WxYzAbCdEfGhJkMnPqRsTu",
    workspace_role="workspace_developer",
)

print(f"user_id: {member.user_id}")
print(f"workspace_role: {member.workspace_role}")

Lista los miembros de un espacio de trabajo:

client = anthropic.Anthropic()

members = client.organization.workspaces.members.list(
    "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", limit=10
)

# Obtiene automáticamente más páginas según sea necesario, así que `limit` define el tamaño de página, no el total.
for member in members:
    print(f"{member.user_id}: {member.workspace_role}")

Actualiza el rol de un miembro del espacio de trabajo:

client = anthropic.Anthropic()

member = client.organization.workspaces.members.update(
    "user_01WxYzAbCdEfGhJkMnPqRsTu",
    workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
    workspace_role="workspace_admin",
)

print(f"user_id: {member.user_id}")
print(f"workspace_role: {member.workspace_role}")

Elimina un miembro de un espacio de trabajo:

client = anthropic.Anthropic()

removed_member = client.organization.workspaces.members.remove(
    "user_01WxYzAbCdEfGhJkMnPqRsTu", workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
)

print(f"user_id: {removed_member.user_id}")

Claves de API

Supervisa y administra las claves de APIVista previa disponible con enlaces a la referencia de la API — presiona Tab hasta que el foco entre a la tarjeta y Escape para volver.. Cada clave en la respuesta incluye su marca de tiempo expires_at (null para las claves sin vencimiento) y principal, la identidad con la que actúa (consulta Tipos de claves). Para una clave personal, principal es {"type": "user_actor", "user_id": "user_..."}. Para una clave de cuenta de servicio, es {"type": "service_account_actor", "service_account_id": "svac_..."}. Para una clave de espacio de trabajo, es null. Cada clave también tiene un objeto scope: {"type": "workspace", "workspace_id": "wrkspc_..."} para una clave vinculada a un espacio de trabajo, o {"type": "organization"} para una clave que puede funcionar en cualquier espacio de trabajo al que tenga acceso la cuenta. Filtrar la lista por workspace_id con el ID del espacio de trabajo predeterminado devuelve solo las claves vinculadas al espacio de trabajo predeterminado; las claves sin alcance de espacio de trabajo no se devuelven con ningún filtro workspace_id.

Lista las claves de API activas en un espacio de trabajo:

client = anthropic.Anthropic()

api_keys = client.organization.api_keys.list(
    limit=10, status="active", workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
)

# Obtiene automáticamente más páginas según sea necesario, así que `limit` define el tamaño de página, no el total.
for api_key in api_keys:
    print(f"{api_key.id}: {api_key.name} ({api_key.status})")

Renombra o desactiva una clave de API:

client = anthropic.Anthropic()

api_key = client.organization.api_keys.update(
    "apikey_01Rj2N8SVvo6BePZj99NhmiT", status="inactive", name="New Key Name"
)

print(f"id: {api_key.id}")
print(f"name: {api_key.name}")
print(f"status: {api_key.status}")

Cuentas de servicio

Crea y administra cuentas de servicio (svac_...), las identidades no humanas con las que actúan las claves de cuenta de servicio y los tokens de Workload Identity Federation. Estos endpoints, al igual que los de emisores de federación y reglas de federación, requieren un token OAuth org:admin. Consulta Cuentas de servicio en Administrar WIF con la Admin API.

Emisores de federación

Registra los proveedores de identidad OIDC (fdis_...) cuyos tokens pueden afirmar la identidad de cargas de trabajo para tu organización. Consulta Emisores de federación en Administrar WIF con la Admin API.

Reglas de federación

Administra las reglas (fdrl_...) que asignan tokens de emisores a cuentas de servicio y alcances. Consulta Reglas de federación en Administrar WIF con la Admin API.

Acceder a la información de la organización

El endpoint /v1/organizations/me devuelve la organización a la que pertenece tu credencial:

client = anthropic.Anthropic()

organization = client.organization.retrieve()

print(f"id: {organization.id}")
print(f"name: {organization.name}")
{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Para conocer los detalles de los parámetros y los esquemas de respuesta, consulta la referencia de la API de información de la organizaciónVista previa disponible con enlaces a la referencia de la API — presiona Tab hasta que el foco entre a la tarjeta y Escape para volver..

Informes de uso y costos

Realiza un seguimiento del uso y los costos de tu organización con la API de análisis de uso y costos. La API de uso y costos es la API heredada para estos datos.

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 “rate limits” (límites de velocidad) configurados para tu organización y sus espacios de trabajo, y establece los límites de velocidad de los espacios de trabajo, con la API de límites de velocidad.

Compliance API

Recupera datos de auditoría y actividad de tu organización con la Compliance API. Las claves de Admin API solo pueden leer el Activity Feed. Para acceso completo, consulta Configurar la Compliance API.

Webhooks de organización

Registra endpoints de webhook para eventos sobre acciones de cumplimiento en los perfiles de usuario de tu organización con webhooks de organización.

Mejores prácticas

  • Usa nombres y descripciones significativos para los espacios de trabajo y las claves de API
  • Maneja los errores de las operaciones fallidas
  • Audita regularmente los roles y permisos de los miembros
  • Archiva los espacios de trabajo sin uso y elimina las invitaciones pendientes que ya no necesites
  • Monitorea el uso de las claves de API, audita el expires_at de cada clave y rota las claves periódicamente

Preguntas frecuentes

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

¿Te resultó útil esta página?