Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Uma chave de API Admin autentica todas as APIs na seção Admin deste guia: a Admin API, as APIs de Analytics, a API de Compliance, a API de Limites de Gastos, a API de Uso e Custo e a API de Limites de Taxa. Você não precisa de uma chave separada para cada API. A única exceção são os endpoints de service-account, federation-issuer e federation-rule da Admin API, que aceitam apenas um token bearer OAuth com o escopo org:admin. Consulte Obter um token bearer OAuth.
Onde você cria a chave depende de qual produto Claude sua organização usa.
| Sua organização | Crie a chave em | Prefixo da chave | Quem pode criá-la | Funciona com |
|---|---|---|---|---|
Claude Console (Claude Platform, platform.claude.com) | Claude Console > Settings > Admin keys | sk-ant-admin01-... | Membros da organização com a função de admin | Admin API, API de Uso e Custo, API de Limites de Taxa, API de Analytics do Claude Code e o Feed de Atividades da API de Compliance |
Claude Enterprise (claude.ai) | claude.ai > Organization settings > API | sk-ant-api01-... | O proprietário principal da organização pai (todas as organizações vinculadas). Um proprietário de organização pode criar uma chave contendo apenas escopos da API de Compliance, restrita à sua própria organização | Gerenciamento de usuários (os endpoints de membros, convites e grupos da Admin API, em beta), API de Compliance, API de Analytics do Claude Enterprise e API de Limites de Gastos, de acordo com os escopos que você selecionar |
Uma chave criada em uma organização não pode ser usada para gerenciar uma organização diferente. Se sua empresa usa tanto o Claude Console quanto o Claude Enterprise, crie uma chave em cada um.
Faça login como administrador da organização
Apenas membros da organização com a função de admin podem criar chaves de API Admin. Consulte Funções e permissões da organização.
Abra as configurações de Admin keys
Crie a chave
Clique em Create key, dê um nome a ela, escolha uma expiração de chave e clique em Create. As chaves do Claude Console não têm escopos selecionáveis; toda chave possui acesso completo a todos os endpoints que aceitam chaves de API Admin (os endpoints de service-account e federation mencionados no topo desta página não aceitam chaves de API Admin).
Copie e armazene o segredo
Copie o segredo exibido (começando com sk-ant-admin01-) e armazene-o em seu gerenciador de segredos. O segredo completo é exibido apenas uma vez.
Faça login como proprietário principal ou proprietário de organização
O proprietário principal da organização pai do Claude Enterprise pode criar uma chave que pode acessar todas as organizações vinculadas, ou uma restrita a uma única organização. Um proprietário de organização pode criar uma chave apenas com escopos da API de Compliance, restrita à sua própria organização.
Abra as configurações de API
Acesse claude.ai > Organization settings > API e encontre a seção Keys.
Clique em + Create key
Nomeie a chave e selecione os escopos de que você precisa na tabela de escopos. O proprietário principal pode combinar escopos de diferentes APIs (por exemplo, read:analytics e read:spend_limits) em uma única chave.
Copie e armazene o segredo
Copie o segredo exibido (começando com sk-ant-api01-) e armazene-o em seu gerenciador de segredos. O segredo completo é exibido apenas uma vez.
Ao criar uma chave do Claude Enterprise, selecione todos os escopos que as APIs que você planeja chamar exigem. Os escopos são fixados na criação; para adicionar um escopo posteriormente, crie uma nova chave.
| Para chamar... | Selecione estes escopos |
|---|---|
| Admin API gerenciamento de usuários: listar e consultar membros e convites; ler funções personalizadas e suas permissões | read:members |
| Admin API gerenciamento de usuários: alterar funções de membros, remover membros, criar e retirar convites | write:members |
| Admin API gerenciamento de usuários: ler grupos e seus membros | read:rbac_groups |
| Admin API gerenciamento de usuários: criar, renomear e excluir grupos; adicionar e remover membros de grupos; atribuir grupos na criação de convites | write:rbac_groups |
| API de Limites de Gastos: ler os limites de gastos efetivos dos membros e solicitações de aumento | read:spend_limits |
| API de Limites de Gastos: definir ou remover limites de gastos por usuário; aprovar ou negar solicitações de aumento | write:spend_limits |
| API de Analytics do Claude Enterprise: relatórios de engajamento, adoção, custo e uso | read:analytics |
| Feed de Atividades da API de Compliance: eventos de atividade em toda a organização | read:compliance_activities |
| Endpoints de conteúdo da API de Compliance: ler chats, arquivos, projetos, transcrições de sessões do Cowork e usuários | read:compliance_user_data |
| Endpoints de conteúdo da API de Compliance: excluir chats, arquivos e projetos | delete:compliance_user_data |
| Endpoints de organização da API de Compliance: ler metadados da organização e configurações efetivas | read:compliance_org_data |
| Endpoints de leitura do gerenciamento de usuários da Admin API e todos os endpoints de leitura da API de Compliance, com um único escopo somente leitura (para integrações de auditoria de segurança; não inclui as APIs de Limites de Gastos ou Analytics) | read:org_audit |
As APIs de Compliance e Analytics devem estar habilitadas para sua organização antes que chaves com esses escopos possam ser usadas. Consulte Configurar a API de Compliance e Obter acesso à API de Analytics do Claude Enterprise.
Passe a chave no cabeçalho x-api-key em cada requisição. Consulte a documentação de cada API para exemplos completos de requisições.
Uma chamada que exceda os escopos da chave retorna 403 Forbidden com uma mensagem listando os escopos que a chave possui e os escopos de que o endpoint precisa.
Gerencie membros da organização, workspaces e chaves de API.
Defina limites de gastos por membro e revise solicitações de aumento para sua organização do Claude Enterprise.
Gere relatórios sobre a produtividade do Claude Code ou o engajamento e a adoção do Claude Enterprise.
Audite atividades e recupere ou exclua conteúdo de usuários em toda a sua organização.
Was this page helpful?