跳转到主要内容
v3 API 提供完整的 RBAC 支持,并通过服务用户身份验证进行访问控制。它是生产环境自动化的推荐 API。
v3 API 当前处于 Beta 测试阶段。随着我们持续改进 API,部分端点可能会发生变化。
基础 URL:
  • https://api.devin.ai/v3beta1/enterprise/* – 需要 Enterprise(账号级) 权限的端点
  • https://api.devin.ai/v3beta1/organizations/* – 作用域限定为单个组织的端点
认证方式: 服务用户凭证(Enterprise 级或组织级)(了解更多
部分 Enterprise 端点虽然是对特定组织进行操作,但仍然受 Enterprise 级权限保护。它们使用类似 /v3beta1/enterprise/organizations/{org_id}/... 的路径(例如:GET /v3beta1/enterprise/organizations/{org_id}/audit-logs)。 即使路径中包含 org_id 路径参数,它们仍然需要 ManageEnterpriseSettings 等 Enterprise 级权限。

权限和 RBAC

v3 API 采用基于角色的访问控制(RBAC)机制,并通过服务用户来实现。每个端点都需要特定权限,这些权限会被分配给服务用户的角色。服务用户可以在 Enterprise 层级或组织层级创建,其权限决定了可以访问哪些端点。

权限类型

v3 API 使用以下权限:
PermissionDescriptionEndpoints
ManageAccountKnowledge在 Enterprise 或组织级别管理 Knowledge 笔记Notes 端点(GET、POST、PUT、DELETE)
ManageAccountPlaybooks在 Enterprise 或组织级别管理 playbooksPlaybooks 端点(GET、POST、PUT、DELETE)
ManageEnterpriseSettings管理整个 Enterprise 范围内的设置,包括组织标签Tags 端点、组织管理

服务用户范围

Enterprise 服务用户 可以访问整个 Enterprise 层面的资源,并且可以在该 Enterprise 下的所有组织之间进行操作。他们使用 /v3beta1/enterprise/* 下的端点。 组织服务用户 的范围限定在某个特定组织内,只能访问该组织内的资源。他们使用 /v3beta1/organizations/{org_id}/* 下的端点。

创建服务用户

可以通过以下方式创建服务用户:
  • Enterprise Settings → Service Users:使用自定义角色创建企业级或组织级服务用户
有关身份验证和令牌生成的详细信息,请参阅身份验证指南

Self

获取已通过身份验证的服务用户信息:

审计日志

访问完整的审计日志:

用量

跟踪详细的用量指标:

组织

通过完整的 RBAC 管理组织:

服务用户

在 Enterprise 级和组织级管理服务用户:

用户

在企业和组织层级管理用户:

IdP 组

在 Enterprise 和组织级别管理 IdP 组:

Git 权限

管理仓库访问权限:

笔记

在企业和组织层级管理 Knowledge 笔记:

Playbook

在 Enterprise 级和组织级管理 Playbook:

会话

管理组织的会话:

标签

管理组织标签(需要启用会话标签功能):

角色与指标

使用示例

查看代码示例

了解 v3 API 的代码示例和常见使用场景