The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

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

A API de Administração requer acesso especial

A API de Administração requer uma chave de API de Administração especial (começando com sk-ant-admin...) que difere das chaves de API padrão. Apenas membros da organização com função de administrador podem provisionar chaves de API de Administração através do Console da Anthropic.

​
Como funciona a API de Administração

Quando você usa a API de Administração:

  1. Você faz solicitações usando sua chave de API de Administração no cabeçalho x-api-key
  2. A API permite que você gerencie:
    • Membros da organização e suas funções
    • Convites para membros da organização
    • Espaços de trabalho e seus membros
    • Chaves de API

Isso é útil para:

  • Automatizar a integração/desligamento de usuários
  • Gerenciar programaticamente o acesso ao espaço de trabalho
  • 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.

FunçãoPermissões
userPode usar o Workbench
claude_code_userPode usar o Workbench e Claude Code
developerPode usar o Workbench e gerenciar chaves de API
billingPode usar o Workbench e gerenciar detalhes de faturamento
adminPode fazer tudo acima, além de gerenciar usuários

​
Conceitos-chave

​
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 "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 "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "newuser@domain.com",
    "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"

​
Espaços de Trabalho

Crie e gerencie espaços de trabalho para organizar seus recursos:

# Criar espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# Listar espaços de trabalho
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Arquivar espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

​
Membros do Espaço de Trabalho

Gerencie o acesso do usuário a espaços de trabalho específicos:

# Adicionar membro ao espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# Listar membros do espaço de trabalho
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 "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Remover membro do espaço de trabalho
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 "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

​
Melhores práticas

Para usar efetivamente a API de Administração:

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

​
Perguntas frequentes