Admin API

A Admin API permite que você gerencie os membros, workspaces, convites e chaves de API da sua organização programaticamente, em vez de manualmente no Claude Console.

Autenticação

Autentique-se com qualquer uma das três credenciais. Uma chave de Admin API cobre a maioria dos endpoints. Os endpoints de conta de serviço, emissor de federação e regra de federação aceitam apenas um token OAuth org:admin. Envie uma chave pessoal ou chave de conta de serviço no cabeçalho x-api-key, como você faria com uma chave de Admin API. Os exemplos a seguir chamam o endpoint de informações da organização com um token OAuth e com uma chave de Admin API.

Os SDKs de Python, TypeScript, C#, Go, Java, PHP e Ruby expõem os endpoints desta página em client.organization, e a CLI ant em ant organization. Os exemplos desta página usam o cliente padrão, que lê uma chave de Admin API de ANTHROPIC_API_KEY ou um token bearer OAuth de ANTHROPIC_AUTH_TOKEN. Os métodos de listagem dos SDKs em Python, TypeScript, C#, Go e Java retornam um iterador que busca mais páginas sob demanda, então limit define o tamanho da página, não o total. Os exemplos em PHP, Ruby e curl retornam uma página. Na CLI, --limit limita os resultados nas listas de membros, convites, workspaces, membros de workspace e chaves de API. Para os parâmetros e respostas de cada endpoint, consulte a referência da Admin API.

Token bearer OAuth

Faça login com a CLI ant em um perfil dedicado com o escopo org:admin (consulte Acesso de administrador) e, em seguida, exporte o token bearer. --profile admin armazena a credencial org:admin em seu próprio perfil e o torna o perfil ativo da CLI. A variável exportada se aplica a todas as chamadas de SDK e CLI naquele shell. Use um shell reservado para administração, remova a variável quando terminar e volte a CLI ao perfil padrão com ant profile activate default:

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

Tokens interativos têm vida curta. Se as requisições começarem a retornar 401, execute novamente o comando export para atualizar o token.

Os SDKs e a CLI ant leem ANTHROPIC_AUTH_TOKEN automaticamente. Deixe ANTHROPIC_API_KEY sem definição no mesmo shell para que eles enviem o token bearer. Cargas de trabalho automatizadas pulam o login: elas se autenticam por meio de federação de identidade de carga de trabalho, e os SDKs e a CLI realizam a troca de token a partir das variáveis de ambiente de federação. Consulte Inicializar uma carga de trabalho para gerenciar WIF.

Chame a Admin API com o token exportado:

client = anthropic.Anthropic()

organization = client.organization.retrieve()

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

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 esteja vinculado.

Para CI e outras cargas de trabalho não interativas, emita o token com Workload Identity Federation em vez de fazer login interativamente. Consulte Gerenciar WIF com a Admin API.

Chave de Admin API

Para criar uma chave de Admin API para o seu tipo de organização, consulte Criar uma chave de Admin API.

client = anthropic.Anthropic()

organization = client.organization.retrieve()

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

Como a Admin API funciona

Autentique-se com qualquer credencial de Autenticação e, em seguida, gerencie os seguintes recursos:

• Membros da organização e suas funções
• Convites da organização
• Workspaces e seus membros
• Chaves de API
• Contas de serviço, emissores de federação e regras de federação (somente token OAuth org:admin)

Usos comuns incluem automatizar a integração e o desligamento de usuários, gerenciar o acesso a workspaces e auditar chaves de API.

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

Existem cinco funções no nível da organização. Para detalhes, consulte Funções e permissões do API Console.

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

Conceitos principais

Membros da organização

Liste membros da organização, atualize suas funções e remova-os.

Liste os membros da sua organização:

client = anthropic.Anthropic()

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

# Busca automaticamente mais páginas conforme necessário.
for user in users:
    print(f"{user.id}: {user.email} ({user.role})")

Atualize a função de um membro:

client = anthropic.Anthropic()

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

print(f"id: