Se você estiver em um plano Teams com uma única organização e não precisar de funções personalizadas, o início rápido do Teams é mais simples.
Entendendo os escopos de usuários de serviço
| Escopo | URL base | Caso de uso |
|---|---|---|
| Enterprise | /v3/enterprise/* | Gerenciamento entre organizações, análises, logs de auditoria, gerenciamento de membros |
| Organização | /v3/organizations/{org_id}/* | Sessões, Knowledge, playbooks, segredos dentro de uma única organização |
Etapa 1: Crie um usuário de serviço
Usuário de serviço do Enterprise (acesso entre organizações)
- Acesse Enterprise settings > Service users
- Clique em Create service user
- Escolha um nome (por exemplo, “Analytics Dashboard”, “Org Provisioning Bot”)
- Atribua uma função do Enterprise com as permissões necessárias para a sua integração
Usuário de serviço da organização (acesso a uma única organização)
- Acesse Settings > Service users na organização de destino
- Clique em Create service user
- Escolha um nome e atribua uma função em nível de organização
Etapa 2: Gerar uma chave de API
- Após criar o usuário de serviço, clique em Generate API key
- Copie a chave imediatamente — ela começa com
cog_e não será exibida novamente - Armazene-a com segurança como uma variável de ambiente:
Etapa 3: Faça sua primeira chamada à API
Exemplo de endpoint Enterprise
Exemplo de endpoint de organização
Permissões e RBAC
- Permissões Enterprise — controlam os endpoints
/v3/enterprise/*(por exemplo,ManageOrganizations,ManageBilling,ViewAccountMetrics) - Permissões de organização — controlam os endpoints
/v3/organizations/{org_id}/*(por exemplo,UseDevinSessions,ManageOrgSecrets,ManageOrgPlaybooks)
ViewAccountSessions concede ViewOrgSessions em todas as organizações.
Para a referência completa de permissões, consulte a documentação de permissões e RBAC.
Fluxos de trabalho comuns no Enterprise
Monitorar o consumo em várias organizações
Recuperar logs de auditoria
Gerenciar usuários entre organizações
Próximas etapas
- Consulte a referência completa de permissões da API
- Saiba mais, em profundidade, sobre autenticação
- Configure a paginação para conjuntos grandes de resultados
- Revise o guia de migração se você estiver migrando da v1/v2
