AdministraçãoOrganização

Admin API

A Admin API não está disponível para contas individuais. Para colaborar com colegas de equipe e adicionar membros, configure sua organização em Console → Settings → Organization.

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.

A Admin API requer acesso especial

A Admin API requer uma chave de 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 admin podem provisionar chaves de Admin API através do Claude Console.

Claude Platform na AWS: A maior parte da Admin API não está disponível na Claude Platform na AWS. Os endpoints de workspace (criar, obter, listar, atualizar e arquivar em /v1/organizations/workspaces) estão disponíveis. Outros endpoints, incluindo membros da organização, membros de workspace, convites, chaves de API, relatórios de uso, relatórios de custo e relatórios de limite de taxa, não estão disponíveis. Consulte Claude Platform na AWS para mais detalhes.

Como a Admin API funciona

Quando você usa a Admin API:

Você faz requisições usando sua chave de Admin API no header x-api-key
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

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.

Função	Permissões
user	Pode usar o Workbench
claude_code_user	Pode usar o Workbench e o Claude Code
developer	Pode usar o Workbench e gerenciar chaves de API
billing	Pode usar o Workbench e gerenciar detalhes de cobrança
admin	Pode fazer tudo acima, além de gerenciar usuários

Conceitos principais

Membros da organização

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

cURL

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

cURL

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

cURL

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

cURL

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

Acessando informações da organização

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

Por exemplo:

cURL

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 que falharem
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.

Was this page helpful?

AdministraçãoOrganização

Admin API

A Admin API não está disponível para contas individuais. Para colaborar com colegas de equipe e adicionar membros, configure sua organização em Console → Settings → Organization.

A Admin API requer acesso especial

Como a Admin API funciona

Quando você usa a Admin API:

Você faz requisições usando sua chave de Admin API no header x-api-key
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

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.

Função	Permissões
user	Pode usar o Workbench
claude_code_user	Pode usar o Workbench e o Claude Code
developer	Pode usar o Workbench e gerenciar chaves de API
billing	Pode usar o Workbench e gerenciar detalhes de cobrança
admin	Pode fazer tudo acima, além de gerenciar usuários

Conceitos principais

Membros da organização

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

cURL

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

cURL

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

cURL

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

cURL

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

Acessando informações da organização

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

Por exemplo:

cURL

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

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 que falharem
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.

Was this page helpful?

Como a Admin API funciona

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

Conceitos principais

Membros da organização

Convites da organização

Workspaces

Membros de workspace

Chaves de API

Acessando informações da organização

Relatórios de uso e custo

Análises do Claude Code

Limites de taxa

Compliance API

Melhores práticas

FAQ

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?

Admins da organização podem ser removidos através da API?

Por quanto tempo os convites da organização duram?

Como a Admin API funciona

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

Conceitos principais

Membros da organização

Convites da organização

Workspaces

Membros de workspace

Chaves de API

Acessando informações da organização

Relatórios de uso e custo

Análises do Claude Code

Limites de taxa

Compliance API

Melhores práticas

FAQ

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?

Admins da organização podem ser removidos através da API?

Por quanto tempo os convites da organização duram?