跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

本指南将引导你为具备自定义角色、RBAC 和多组织支持的 企业组织 配置 API 访问权限。
如果你使用的是仅包含单个组织且不需要自定义角色的团队版方案,可以参考更简单的 Teams 快速入门
如果你是拥有专用部署的 Devin Enterprise 客户,你需要将所有 API URL 中的 api.devin.ai 替换为你组织的自定义 API 域名 (例如,api.your-company.devinenterprise.com) 。如果你不确定贵组织的 API 域名,请联系你的 Devin 管理员或 Cognition 支持团队。

了解服务用户作用域

Enterprise 客户可以在两个层级创建服务用户:
作用域基础 URL使用场景
Enterprise/v3/enterprise/*跨组织管理、分析、审计日志、成员管理
Organization/v3/organizations/{org_id}/*单个组织内的会话、Knowledge、playbook、机密信息
具有 Enterprise 级权限的服务用户会在所有组织中自动继承相应的组织级权限。

步骤 1:创建服务用户

Enterprise 服务用户 (跨组织访问)

  1. 前往 Enterprise settings > Service users
  2. 点击 Create service user
  3. 选择一个名称 (例如:“Analytics Dashboard”、“Org Provisioning Bot”)
  4. 为其分配一个 Enterprise 角色,使其具备集成所需的权限

组织服务用户 (单组织访问)

  1. 在目标组织中进入 Settings > Service users
  2. 点击 Create service user
  3. 选择名称并分配组织级角色
遵循最小权限原则:当你的集成只需要访问一个组织时,创建以该组织为作用域的服务用户。仅在需要跨组织的工作流时使用 Enterprise 服务用户。

步骤 2:生成 API key

  1. 创建服务账户后,点击 Generate API key 按钮
  2. 立即复制该 API key——它以 cog_ 开头,且不会再次显示
  3. 将其安全保存为环境变量:
export DEVIN_API_KEY="cog_your_key_here"

第 3 步:发起第一次 API 调用

Enterprise 端点示例

列出你 Enterprise 帐户中的所有组织:
curl "https://api.devin.ai/v3/enterprise/organizations" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

组织端点示例

在指定组织中创建 Devin 会话:
export DEVIN_ORG_ID="your_org_id"

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Implement the feature described in JIRA-123"}'

权限与 RBAC

每个 API 端点都受特定权限控制。每个端点所需的权限都记录在该端点的 API 参考页面中。权限分为两个层级:
  • Enterprise 权限 — 控制 /v3/enterprise/* 端点 (例如 ManageOrganizationsManageBillingViewAccountMetrics)
  • 组织权限 — 控制 /v3/organizations/{org_id}/* 端点 (例如 UseDevinSessionsManageOrgSecretsManageOrgPlaybooks)
拥有 Enterprise 级权限的 Enterprise 服务用户,会自动在所有组织中继承相应的组织级权限。例如,ViewAccountSessions 会在每个组织中授予 ViewOrgSessions 完整的权限参考请参阅权限与 RBAC 文档

常见企业级工作流程

跨组织监控用量

# 获取每日消耗明细(使用 Unix 时间戳 — 示例:2025 年 1 月 1 日至 1 月 31 日)
curl "https://api.devin.ai/v3/enterprise/consumption/daily?time_after=1735689600&time_before=1738368000" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

审计日志检索

curl "https://api.devin.ai/v3/enterprise/audit-logs" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

跨组织管理用户

# 列出企业用户
curl "https://api.devin.ai/v3/enterprise/members/users" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

# 列出特定组织中的用户
curl "https://api.devin.ai/v3/enterprise/organizations/$DEVIN_ORG_ID/members/users" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

后续步骤