Admin API

A Admin API permite que você gerencie programaticamente os recursos da sua organização, incluindo membros da organização, workspaces e chaves de API. Isso fornece controle programático sobre tarefas administrativas que, de outra forma, exigiriam configuração manual no Claude Console.



Autenticação

Autentique-se com qualquer uma das credenciais. Os exemplos a seguir chamam o endpoint de informações da organização das duas formas:

OAuth bearer:

curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"

Um token org:admin concede acesso a toda a organização, independentemente do workspace ao qual o perfil subjacente ou a regra de federação está vinculado. Para obter um, consulte os pré-requisitos em Gerenciar WIF com a Admin API.

Chave de Admin API:

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



Como a Admin API funciona

Quando você usa a Admin API:

1. Você faz requisições usando qualquer uma das credenciais da seção Autenticação
2. A API permite que você gerencie:
   • Membros da organização e suas funções
   • Convites de membros da organização
   • Workspaces e seus membros
   • Chaves de API
   • Contas de serviço, emissores de federação e regras de federação (esses endpoints exigem um token OAuth org:admin; chaves de Admin API não são aceitas)

Isso é útil para:

• Automatizar o onboarding/offboarding de usuários
• Gerenciar programaticamente o acesso a workspaces
• Monitorar e gerenciar o uso de chaves de API



Funções e permissões da organização

Existem cinco funções no nível da organização. Veja mais detalhes no artigo Funções e permissões do API Console.

Owners e primary owners da organização têm todas as permissões de admin e podem, adicionalmente, gerenciar admins. Todas as referências à função de admin nesta página também se aplicam a owners e primary owners.



Conceitos principais



Membros da organização

Você pode listar membros da organização, atualizar funções de membros e remover membros.

# Listar membros da organização
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Atualizar função do membro
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"}'

# Remover membro
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"



Convites da organização

Você pode convidar usuários para organizações e gerenciar esses convites.

# Criar convite
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 convites
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Excluir convite
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"



Workspaces

Para um guia abrangente sobre workspaces, incluindo exemplos do Console e da API, consulte Workspaces.



Membros de workspace

Gerencie o acesso de usuários a workspaces específicos:

# Adicionar membro ao workspace
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 membros do workspace
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"

# Atualizar função do membro
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"
  }'

# Remover membro do workspace
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"



Chaves de API

Monitore e gerencie chaves de API:

# Listar chaves 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"

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



Contas de serviço

Crie e gerencie contas de serviço (svac_...), as identidades não humanas que os tokens de Workload Identity Federation representam. Chaves de Admin API não são aceitas nos endpoints de contas de serviço, emissores de federação ou regras de federação; use um token OAuth org:admin. Consulte Gerenciar WIF com a Admin API.



Emissores de federação

Registre os provedores de identidade OIDC (fdis_...) cujos tokens podem declarar identidade de workload para sua organização. Consulte Gerenciar WIF com a Admin API.



Regras de federação

Gerencie as regras (fdrl_...) que mapeiam tokens de emissores para contas de serviço e escopos. Consulte Gerenciar WIF com a Admin API.



Acessando informações da organização

Obtenha informações sobre sua organização programaticamente com o endpoint /v1/organizations/me.

Por exemplo:

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 é útil para determinar programaticamente a qual organização uma chave de Admin API pertence.

Para detalhes completos de parâmetros e esquemas de resposta, consulte a referência da API de Informações da Organização.



Relatórios de uso e custo

Acompanhe o uso e os custos da sua organização com a API de Uso e Custo.



Análises do Claude Code

Monitore a produtividade dos desenvolvedores e a adoção do Claude Code com a API de Análises do Claude Code.



Limites de taxa

Leia os limites de taxa configurados para sua organização e seus workspaces com a API de Limites de Taxa.



Compliance API

Recupere dados de auditoria e atividade da sua organização com a Compliance API. Chaves de Admin API podem ler apenas o Feed de Atividades; para acesso completo, consulte Obter acesso à Compliance API.



Melhores práticas

Para usar a Admin API de forma eficaz:

• Use nomes e descrições significativos para workspaces e chaves de API
• Implemente tratamento de erros adequado para operações com falha
• Audite regularmente as funções e permissões dos membros
• Limpe workspaces não utilizados e convites expirados
• Monitore o uso de chaves de API e faça a rotação das chaves periodicamente



FAQ

Para perguntas específicas sobre workspaces, consulte o FAQ de Workspaces.