API de Administração
A API de Administração 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 Console Anthropic.
A API de Administração requer acesso especial
A API de Administração requer uma chave de API de Administração especial (começando com sk-ant-admin...) que difere das chaves de API padrão. Apenas membros da organização com função de administrador podem provisionar chaves de API de Administração através do Console Anthropic.
Como funciona a API de Administração
Quando você usa a API de Administração:
- Você faz solicitações usando sua chave de API de Administração no cabeçalho
x-api-key - A API permite que você gerencie:
- Membros da organização e suas funções
- Convites para membros da organização
- Espaços de trabalho e seus membros
- Chaves de API
Isso é útil para:
- Automatizar a integração/desligamento de usuários
- Gerenciar programaticamente o acesso aos espaços de trabalho
- Monitorar e gerenciar o uso de chaves de API
Funções e permissões da organização
Existem quatro funções no nível da organização.
| Função | Permissões |
|---|---|
| user | Pode usar o Workbench |
| developer | Pode usar o Workbench e gerenciar chaves de API |
| billing | Pode usar o Workbench e gerenciar detalhes de faturamento |
| 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.
Convites da Organização
Você pode convidar usuários para organizações e gerenciar esses convites.
Espaços de Trabalho
Crie e gerencie espaços de trabalho para organizar seus recursos:
Membros do Espaço de Trabalho
Gerencie o acesso do usuário a espaços de trabalho específicos:
Chaves de API
Monitore e gerencie chaves de API:
Melhores práticas
Para usar efetivamente a API de Administração:
- Use nomes e descrições significativos para espaços de trabalho e chaves de API
- Implemente tratamento adequado de erros 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 faça rotação periódica das chaves
Perguntas Frequentes
Was this page helpful?