Criar uma chave de API Admin
Crie uma chave de API Admin para sua organização do Claude Console ou Claude Enterprise.
Uma chave de API de Admin autentica todas as APIs na seção Administração deste guia: a Admin API, as APIs de Analytics, a Compliance API, a API de Plugins, a API do Claude Tag, a API de Limites de Gastos, a API de Análise de Uso e Custo, 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 conta de serviço, emissor de federação e regra de federação 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.
De qual chave você precisa?
| Sua organização | Crie a chave em | Prefixo da chave | Quem pode criá-la | Funciona com |
|---|---|---|---|---|
Claude Console (Claude Platform, platform.claude.com) | Página Chaves de administrador (platform.claude.com/settings/admin-keys) no Claude Console | sk-ant-admin01-... | Membros da organização com a função admin | Admin API, API de Análise de Uso e Custo, API de Uso e Custo, API de Limites de Taxa, API de Analytics do Claude Code e o Activity Feed da Compliance API |
Claude Enterprise (claude.ai) | claude.ai > Configurações da organização > API | sk-ant-api01-... | O Principal proprietário da organização pai (todas as organizações vinculadas). Um proprietário da organização pode criar uma chave contendo apenas escopos da Compliance API, restrita à sua própria organização | Gerenciamento de usuários (os endpoints de membros, convites e grupos da Admin API), API de Plugins, API do Claude Tag, Compliance API, Claude Enterprise Analytics API, API de Análise de Uso e Custo 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.
Criar uma chave para uma organização do Claude Console
Faça login como admin da organização
Apenas membros da organização com a função admin podem criar chaves de API Admin. Consulte Funções e permissões da organização.
Abra as configurações de Chaves de administrador
No Claude Console, acesse a página Chaves de administrador (
platform.claude.com/settings/admin-keys).Crie a chave
Clique em Criar chave de administrador, dê um nome a ela, selecione uma expiração da chave e clique em Adicionar. As chaves do Claude Console não têm escopos selecionáveis; toda chave possui acesso total a todos os endpoints que aceitam chaves de Admin API (os endpoints de service account e federation mencionados no topo desta página não aceitam chaves de Admin API).
Copie e armazene o segredo
Copie o segredo exibido (começando com
sk-ant-admin01-) e armazene-o no seu gerenciador de segredos. O segredo completo é exibido apenas uma vez.
Criar uma chave para uma organização do Claude Enterprise
Faça login como proprietário principal ou proprietário da 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 da organização pode criar uma chave apenas com escopos da Compliance API, restrita à sua própria organização.
Abra as configurações de API
Acesse claude.ai > Configurações da organização > API e localize a seção Chaves.
Clique em + Criar chave
Dê um nome à 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:analyticseread:spend_limits) em uma única chave.Copie e armazene o segredo
Copie o segredo exibido (começando com
sk-ant-api01-) e armazene-o no seu gerenciador de segredos. O segredo completo é exibido apenas uma vez.
Escolher escopos para uma chave do Claude Enterprise
Ao criar uma chave do Claude Enterprise, selecione todos os escopos exigidos pelas APIs que você planeja chamar. Os escopos são fixados na criação; para adicionar um escopo posteriormente, crie uma nova chave.
| Para chamar... | Selecione estes escopos |
|---|---|
| Gerenciamento de usuários da Admin API: listar e consultar membros e convites; ler funções personalizadas e suas permissões | read:members |
Gerenciamento de usuários da Admin API: alterar funções de membros, remover membros, desconectar membros de todos os lugares (beta), criar e retirar convites (para atribuir a função managed em uma alteração de função ou em um convite, selecione também write:rbac_groups) | write:members |
| Gerenciamento de usuários da Admin API: ler grupos e seus membros | read:rbac_groups |
Gerenciamento de usuários da Admin API: criar, renomear e excluir grupos; adicionar e remover membros de grupos; com write:members, atribuir a função managed (em um convite ou em uma alteração de função) ou atribuir grupos em um convite | write:rbac_groups |
| API de Plugins: ler plugins, versões, configurações de instalação, compartilhamentos e marketplaces; baixar arquivos de plugins, incluindo os arquivos dos plugins pessoais dos membros; validar um marketplace antes de conectá-lo | read:plugins |
API de Plugins: enviar plugins e versões; escolher qual versão é servida aos membros; excluir plugins, incluindo plugins pessoais dos membros; definir e remover configurações de instalação; definir a configuração de instalação padrão de um marketplace; validar um marketplace antes de conectá-lo (para ler plugins, selecione também read:plugins) | write:plugins |
| Claude Tag API: ler as configurações do Claude Tag em canais do Slack e workspaces do Slack; listar Pacotes de acesso e onde estão anexados (nenhum outro escopo concede acesso à Claude Tag API) | read:claude_tag |
API do Claude Tag: configurar e remover canais; alterar configurações; anexar e desanexar Pacotes de acesso (para também ler, selecione também read:claude_tag) | write:claude_tag |
| 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 |
| Claude Enterprise Analytics API: relatórios de engajamento, adoção, custo e uso; API de Análise de Uso e Custo: relatórios de uso de tokens e custo | read:analytics |
| Activity Feed da Compliance API: eventos de atividade de toda a organização | read:compliance_activities |
| Endpoints de chat, arquivo e projeto da Compliance API e endpoints de sessão da Compliance API: ler chats, arquivos, projetos, transcrições de sessões e usuários da organização | read:compliance_user_data |
| Endpoints de chat, arquivo e projeto da Compliance API: excluir chats, arquivos e projetos | delete:compliance_user_data |
Endpoints de organização da Compliance API: ler metadados da organização e configurações efetivas; API de Plugins: todos os endpoints GET, incluindo downloads de arquivos | read:compliance_org_data |
Endpoints de leitura de gerenciamento de usuários da Admin API, todos os endpoints de leitura da Compliance API e todos os endpoints GET da API de Plugins, incluindo downloads de arquivos, 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 Compliance e Analytics APIs devem estar habilitadas para sua organização antes que chaves com esses escopos possam ser usadas. Consulte Configurar a Compliance API e Obter acesso à Claude Enterprise Analytics API.
Você só pode criar e usar chaves com read:plugins ou write:plugins se sua organização puder usar a API de Plugins. O guia da API de Plugins informa quais organizações podem usá-la. Nessas organizações, chaves com read:org_audit ou read:compliance_org_data também podem chamar os endpoints de leitura da API de Plugins, incluindo downloads de arquivos, mas não a validação de marketplace. Os escopos read:plugins e write:plugins atuam apenas na organização em que a chave foi criada. Consulte Escopos da API de Plugins e Ler outra organização sob a mesma organização-mãe.
Usar a chave
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 excede 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.
Próximos passos
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.
Esta página foi útil?