A API v3 está atualmente em beta. Alguns endpoints podem mudar à medida que aprimoramos a API.
https://api.devin.ai/v3beta1/enterprise/*– endpoints que exigem permissões em nível Enterprisehttps://api.devin.ai/v3beta1/organizations/*– endpoints com escopo para uma única organização
Alguns endpoints Enterprise operam em organizações específicas, mas ainda assim são protegidos
por permissões em nível Enterprise. Eles usam caminhos como
/v3beta1/enterprise/organizations/{org_id}/...
(por exemplo, GET /v3beta1/enterprise/organizations/{org_id}/audit-logs).
Mesmo que incluam um parâmetro de caminho org_id, eles ainda exigem
permissões em nível Enterprise, como ManageEnterpriseSettings.Permissões e RBAC
/v3beta1/enterprise/*, e permissões de nível de organização controlam os endpoints /v3beta1/organizations/{org_id}/*. Um usuário de serviço Enterprise com uma permissão em nível de Enterprise herda automaticamente a permissão correspondente em nível de organização em todas as organizações.
Permissões de Enterprise
| Permissão | Controles |
|---|---|
ReadAccountMeta | Próprio usuário (concedida a todos os usuários de serviço por padrão) |
ManageEnterpriseSettings | Logs de auditoria, tags de organização |
ManageOrganizations | CRUD de organizações, limites de grupos de organização |
ManageAccountMembership | Funções, usuários Enterprise, grupos de IdP Enterprise, associação de usuários de serviço Enterprise, registro de grupos de IdP Enterprise |
ManageAccountServiceUsers | Provisionamento de usuários de serviço (Enterprise) |
ManageAccountKnowledge | Notas do Knowledge (Enterprise) |
ManageAccountPlaybooks | Playbooks (Enterprise) |
ManageGitIntegrations | Conexões Git, permissões Git |
ManageBilling | Ciclos de consumo, detalhamento diário do consumo |
ViewAccountMetrics | Métricas de uso (DAU/WAU/MAU, PRs, sessões, pesquisas, usuários ativos), status da fila |
ViewEnterpriseInfraDetails | Hipervisores |
ViewAccountSessions | Lista e detalhes de sessões (Enterprise, somente leitura) |
ManageAccountSessions | Enviar mensagens para sessões (Enterprise) |
ViewAccountSearches | Pesquisas (Enterprise) |
Permissões da organização
| Permission | Controls |
|---|---|
ManageOrgSecrets | CRUD de segredos |
ManageOrgKnowledge | Notas no Knowledge (organização) |
ManageOrgPlaybooks | Playbooks (organização) |
ManageOrgServiceUsers | Provisionamento de usuários de serviço (organização) |
ViewOrgSessions | Lista e detalhes de sessões (organização, somente leitura) |
ManageOrgSessions | Enviar mensagens, encerrar, arquivar sessões |
UseDevinSessions | Criar sessões |
ImpersonateOrgSessions | Criar sessões em nome de outros usuários (create_as_user_id) |
ViewOrgSearches | Pesquisas (organização) |
Escopos de usuários de serviço
/v3beta1/enterprise/* e podem operar em todas as organizações. Eles recebem funções em nível Enterprise e herdam automaticamente as permissões correspondentes em nível de organização em cada organização (por exemplo, ViewAccountSessions concede ViewOrgSessions em todas as organizações).
Usuários de serviço da organização têm escopo limitado a uma única organização e se autenticam apenas pelos endpoints /v3beta1/organizations/{org_id}/*. Eles recebem funções em nível de organização.
Criando usuários de serviço
- UI: Enterprise Settings → Service Users — crie usuários de serviço no nível Enterprise ou de organização com funções personalizadas e gere tokens de API.
- API:
POST /v3beta1/enterprise/service-usersouPOST /v3beta1/organizations/{org_id}/service-users— faça o provisionamento programático de usuários de serviço com uma função e TTL especificados. As permissões do novo usuário devem ser um subconjunto das permissões de quem faz a chamada (a elevação de privilégio é impedida).
Self
Logs de auditoria
Logs de auditoria da Enterprise
Obtenha logs de auditoria em toda a Enterprise
Logs de auditoria da organização
Obtenha logs de auditoria de uma organização específica
Consumo
Ciclos de consumo
Veja resumos dos ciclos de consumo
Consumo diário
Obtenha o detalhamento diário do consumo
Por organização
Acompanhe o consumo por organização
Por usuário
Acompanhe o consumo por usuário
Por sessão
Acompanhe o consumo por sessão
Organizações
Listar Organizações
Ver todas as organizações
Criar Organização
Criar uma nova organização
Atualizar Organização
Atualizar configurações da organização
Excluir Organização
Excluir uma organização
Usuários de serviço
Listar usuários de serviço da Enterprise
Visualizar usuários de serviço da Enterprise
Criar usuário de serviço da Enterprise
Criar um usuário de serviço da Enterprise
Atualizar usuário de serviço da Enterprise
Atualizar um usuário de serviço da Enterprise
Excluir usuário de serviço da Enterprise
Excluir um usuário de serviço da Enterprise
Listar usuários de serviço da organização
Visualizar usuários de serviço da organização
Criar usuário de serviço da organização
Criar um usuário de serviço da organização
Usuários
Listar usuários da Enterprise
Ver usuários da Enterprise
Adicionar usuário à Enterprise
Adicionar um usuário à Enterprise
Atualizar usuário da Enterprise
Atualizar um usuário da Enterprise
Remover usuário da Enterprise
Remover um usuário da Enterprise
Listar usuários da organização
Ver usuários da organização
Adicionar usuário à organização
Adicionar um usuário a uma organização
Grupos de IdP
Listar grupos de Enterprise registrados
Listar grupos de IdP registrados nesta Enterprise
Registrar grupos de Enterprise
Registrar grupos de IdP para esta Enterprise
Remover grupo de Enterprise registrado
Remover um grupo de IdP registrado desta Enterprise
Listar grupos de Enterprise
Exibir atribuições de grupos de IdP da Enterprise
Atribuir grupo de Enterprise
Atribuir uma função de grupo de IdP no nível de Enterprise
Listar grupos da organização
Exibir atribuições de grupos de IdP da organização
Atribuir grupo da organização
Atribuir uma função de grupo de IdP no nível da organização
Permissões do Git
Listar permissões
Visualize as permissões do Git de uma organização
Adicionar permissão
Adicione uma permissão do Git
Remover permissão
Remova uma permissão do Git
Notas
Listar notas Enterprise
Visualizar notas de conhecimento no nível Enterprise
Criar nota Enterprise
Criar uma nova nota no nível Enterprise
Listar notas da organização
Visualizar notas de conhecimento da organização
Criar nota da organização
Criar uma nova nota da organização
Playbooks
Listar Playbooks Enterprise
Visualizar playbooks Enterprise
Criar Playbook Enterprise
Criar novo playbook Enterprise
Listar Playbooks da Organização
Visualizar playbooks da organização
Criar Playbook da Organização
Criar novo playbook da organização
Sessões
Listar sessões
Exibir sessões de uma organização
Criar sessão
Criar uma nova sessão
Encerrar sessão
Encerrar uma sessão ativa
Arquivar sessão
Arquivar uma sessão para referência futura
Listar Tags
Visualizar tags de uma organização
Adicionar Tags
Adicionar tags a uma organização
Substituir Tags
Substituir todas as tags de uma organização
Excluir Tag
Remover uma tag específica
Funções e métricas
Listar funções
Ver funções disponíveis
Métricas de uso
Obter métricas de uso do Enterprise
Métricas da organização
Obter métricas de uso da organização
Exemplos de Uso
Ver Exemplos de Código
Confira exemplos de código e casos de uso comuns da API v3