Visão geral da Admin API

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

A Admin API 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 Claude Console.

A Admin API requer acesso especial

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

Como a Admin API funciona

Quando você usa a Admin API:

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

Isso é útil para:

Automatizar integração/desintegração 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. Veja mais detalhes no artigo Funções e permissões do Console de API.

Função	Permissões
user	Pode usar Workbench
claude_code_user	Pode usar Workbench e Claude Code
developer	Pode usar Workbench e gerenciar chaves de API
billing	Pode usar Workbench e gerenciar detalhes de faturamento
admin	Pode 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.

Shell

# 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.

Shell

# 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": "[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"

# Deletar 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

Para um guia abrangente sobre espaços de trabalho, incluindo exemplos do Console e API, veja Workspaces.

Membros do Espaço de Trabalho

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

Shell

# 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:

Shell

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

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: $ADMIN_API_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Este endpoint é útil para determinar programaticamente a qual organização uma chave Admin API pertence.

Para detalhes completos de parâmetros e esquemas de resposta, veja 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álise do Claude Code

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

Melhores práticas

Para usar efetivamente a Admin API:

Use nomes e descrições significativos para espaços de trabalho 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 espaços de trabalho não utilizados e convites expirados
Monitore o uso de chaves de API e rotacione as chaves periodicamente

Perguntas frequentes

Para perguntas específicas sobre espaços de trabalho, veja as Perguntas frequentes sobre Workspaces.

Como a Admin API funciona

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

Conceitos-chave

Membros da Organização

Convites da Organização

Espaços de Trabalho

Membros do Espaço de Trabalho

Chaves de API

Acessando informações da organização

Relatórios de uso e custo

Análise do Claude Code

Melhores práticas

Perguntas frequentes

Quais permissões são necessárias para usar a Admin API?

Posso criar novas chaves de API através da Admin API?

O que acontece com as chaves de API ao remover um usuário?

Os administradores da organização podem ser removidos via API?

Quanto tempo os convites da organização duram?