AdminOrganização

Admin API

Gerencie membros da organização, workspaces, convites e chaves de API programaticamente com a Admin API, usando uma chave de Admin API ou um token OAuth org:admin.

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 aceita duas credenciais:

Uma chave de Admin API (começando com sk-ant-admin...) enviada no cabeçalho x-api-key. Apenas membros da organização com a função de admin podem provisionar uma. Consulte Criar uma chave de Admin API.
Um token bearer OAuth com o escopo org:admin enviado no cabeçalho authorization: Bearer. Apenas membros com a função de admin, owner ou primary owner podem obter um. Consulte Obter um token bearer OAuth.

Claude Enterprise: Organizações Claude Enterprise (claude.ai) também usam a Admin API, com uma chave de API com escopo criada no claude.ai. Dos endpoints nesta página, apenas membros e convites estão disponíveis para elas (em beta), junto com endpoints exclusivos do Claude Enterprise: grupos e leituras de funções personalizadas (beta), e limites de gastos. Consulte Gerenciamento de usuários para Claude Enterprise.

Claude Platform na AWS: A maior parte da Admin API não está disponível no 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 detalhes.

Autenticação

Autentique-se com qualquer uma das credenciais. Uma chave de Admin API cobre a maioria dos endpoints; os endpoints de service-account, federation-issuer e federation-rule aceitam apenas um token OAuth org:admin. Os exemplos a seguir chamam o endpoint de informações da organização das duas formas.

Token bearer OAuth

Faça login com a CLI ant sob um perfil dedicado, solicitando o escopo org:admin (consulte Acesso de admin), e então exporte o token bearer. Um perfil dedicado evita que seus comandos rotineiros sejam executados com acesso elevado:

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_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, que atualiza o token automaticamente.

Chame a Admin API com o token exportado:

cURL

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 CI e outras cargas de trabalho não interativas, gere 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.

cURL

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:

Você faz requisições usando qualquer uma das credenciais da seção Autenticação
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
- Service accounts, federation issuers e federation rules (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.

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 faturamento
admin	Pode fazer tudo o que foi mencionado acima, além de gerenciar usuários

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.

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. Cada chave na resposta inclui seu timestamp expires_at (null para chaves sem uma expiração):

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

Service accounts

Crie e gerencie service accounts (svac_...), as identidades não humanas como as quais os tokens de Workload Identity Federation atuam. Chaves de Admin API não são aceitas nos endpoints de service-account, federation-issuer ou federation-rule; use um token OAuth org:admin. Consulte Gerenciar WIF com a Admin API.

Federation issuers

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

Federation rules

Gerencie as regras (fdrl_...) que mapeiam tokens de issuers para service accounts 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

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 Activity Feed; para acesso completo, consulte Configurar a 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, audite o expires_at de cada chave e faça a rotação das chaves periodicamente

Perguntas frequentes

Para perguntas específicas sobre workspaces, consulte as Perguntas frequentes sobre Workspaces.

Was this page helpful?

AdminOrganização

Admin API

Gerencie membros da organização, workspaces, convites e chaves de API programaticamente com a Admin API, usando uma chave de Admin API ou um token OAuth org:admin.

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

A Admin API aceita duas credenciais:

Uma chave de Admin API (começando com sk-ant-admin...) enviada no cabeçalho x-api-key. Apenas membros da organização com a função de admin podem provisionar uma. Consulte Criar uma chave de Admin API.
Um token bearer OAuth com o escopo org:admin enviado no cabeçalho authorization: Bearer. Apenas membros com a função de admin, owner ou primary owner podem obter um. Consulte Obter um token bearer OAuth.

Autenticação

Token bearer OAuth

CLI

ant auth login --profile admin --scope "org:admin"
export ANTHROPIC_OAUTH_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, que atualiza o token automaticamente.

Chame a Admin API com o token exportado:

cURL

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 CI e outras cargas de trabalho não interativas, gere 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.

cURL

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:

Você faz requisições usando qualquer uma das credenciais da seção Autenticação
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
- Service accounts, federation issuers e federation rules (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.

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 faturamento
admin	Pode fazer tudo o que foi mencionado 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. Cada chave na resposta inclui seu timestamp expires_at (null para chaves sem uma expiração):

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

Service accounts

Federation issuers

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

Federation rules

Gerencie as regras (fdrl_...) que mapeiam tokens de issuers para service accounts 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

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 Activity Feed; para acesso completo, consulte Configurar a 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, audite o expires_at de cada chave e faça a rotação das chaves periodicamente

Perguntas frequentes

Para perguntas específicas sobre workspaces, consulte as Perguntas frequentes sobre Workspaces.

Was this page helpful?

Autenticação

Token bearer OAuth

Chave de Admin API

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

Service accounts

Federation issuers

Federation rules

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

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?

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

Quanto tempo duram os convites da organização?

Autenticação

Token bearer OAuth

Chave de Admin API

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

Service accounts

Federation issuers

Federation rules

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

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?

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

Quanto tempo duram os convites da organização?

Autenticação

Token bearer OAuth

Chave de Admin API

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

Service accounts

Federation issuers

Federation rules

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

Perguntas frequentes

Autenticação

Token bearer OAuth

Chave de Admin API

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

Service accounts

Federation issuers

Federation rules

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

Perguntas frequentes