Pular para o conteúdo principal
A API v3 oferece suporte completo a RBAC com autenticação de usuário de serviço. Esta é a API recomendada para automação em produção.
A API v3 está atualmente em beta. Alguns endpoints podem mudar à medida que aprimoramos a API.
URLs base:
  • https://api.devin.ai/v3beta1/enterprise/* – endpoints que exigem permissões Enterprise (nível de conta)
  • https://api.devin.ai/v3beta1/organizations/* – endpoints com escopo para uma única organização
Autenticação: credenciais de usuário de serviço (nível Enterprise ou de organização) (saiba mais)
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

A API v3 usa Controle de Acesso Baseado em Funções (RBAC) com usuários de serviço. Cada endpoint exige permissões específicas atribuídas à função do usuário de serviço. Usuários de serviço podem ser criados no nível Enterprise ou no nível da organização, e suas permissões determinam quais endpoints eles podem acessar.

Tipos de permissão

A API v3 usa as seguintes permissões:
PermissionDescriptionEndpoints
ManageAccountKnowledgeGerenciar notas do Knowledge em nível de Enterprise ou de organizaçãoEndpoints de Notes (GET, POST, PUT, DELETE)
ManageAccountPlaybooksGerenciar playbooks em nível de Enterprise ou de organizaçãoEndpoints de Playbooks (GET, POST, PUT, DELETE)
ManageEnterpriseSettingsGerenciar configurações em todo o Enterprise, incluindo tags de organizaçãoEndpoints de Tags, gerenciamento de organizações

Escopos de Service Users

Enterprise Service Users têm acesso a recursos em todo o ambiente Enterprise e podem operar em todas as organizações desse Enterprise. Eles usam endpoints em /v3beta1/enterprise/*. Organization Service Users são limitados a uma organização específica e só podem acessar recursos dentro dessa organização. Eles usam endpoints em /v3beta1/organizations/{org_id}/*.

Criando usuários de serviço

Usuários de serviço podem ser criados por meio de:
  • Enterprise Settings → Service Users: Crie usuários de serviço no nível Enterprise ou no nível da organização, com funções personalizadas
Para obter informações detalhadas sobre autenticação e geração de tokens, consulte o Guia de Autenticação.

Self

Obtenha informações sobre o usuário de serviço autenticado:

Logs de auditoria

Acesse históricos de auditoria abrangentes:

Consumo

Acompanhe métricas detalhadas de consumo:

Organizações

Gerencie organizações com controle de acesso baseado em função (RBAC) completo:

Usuários de serviço

Gerencie usuários de serviço nos níveis Enterprise e de organização:

Usuários

Gerencie usuários nos níveis de Enterprise e de organização:

Grupos de IdP

Gerencie grupos de IdP nos níveis Enterprise e de organização:

Permissões do Git

Gerencie o acesso ao repositório:

Notas

Gerencie notas de conhecimento nos níveis Enterprise e de organização:

Playbooks

Gerencie playbooks nos níveis Enterprise e de organização:

Sessões

Gerencie sessões da organização:

Tags

Gerenciar tags da organização (requer o recurso de tags de sessão):

Funções e métricas

Exemplos de uso

Ver exemplos de código

Confira exemplos de código e casos de uso comuns da API v3