主体与令牌
所有 API 凭据均采用
cog_ 前缀格式。请在每个请求的 Authorization 请求头中附上你的令牌:
- Service User API 密钥 以服务用户身份进行认证——适用该服务用户的身份、权限和 org 成员资格。
- Personal Access Token 以创建它的人工用户身份进行认证——适用该用户的身份、权限和 org 成员资格。
服务用户 (推荐用于自动化)
工作原理
- 在 Settings > Service users (组织) 或 Enterprise settings > Service users (企业) 中创建一个服务用户
- 为该服务用户分配一个角色,以控制其可访问的端点
- 生成一个 API 密钥——该密钥以
cog_开头,并且只会在创建时显示一次 - 在每个 API 请求的
Authorization请求头中使用该密钥
服务用户作用域
使用 create_as_user_id 进行会话归因
create_as_user_id 参数。该会话会出现在该用户的会话列表中,并计入其使用量。
这要求该服务用户的角色拥有 ImpersonateOrgSessions 权限。
主要属性
- 密钥以
cog_开头,并且只会在创建时显示一次 - 服务用户会在审计日志中与人工用户分开显示
- 权限通过 RBAC 控制——仅为集成分配其所需的权限
- Enterprise 服务用户会在所有组织中继承组织级别权限
个人访问令牌 (封闭测试)
个人访问令牌目前处于封闭测试阶段,并受功能开关控制。联系支持团队以获取访问权限。PAT 不适用于 SSO/企业账户。
旧版身份验证 (已弃用)
生成位置: Settings > API Keys
安全最佳实践
- 安全存储密钥:使用环境变量或机密管理系统
- 定期轮换密钥:定期生成新密钥并撤销旧密钥
- 在自动化中使用服务用户:生产环境中优先使用服务用户而非个人密钥
- 应用最小权限原则:仅授予完成任务所需的最低权限
- 监控使用情况:查看审计日志以发现异常的 API 活动
- 立即撤销已泄露密钥:如果密钥被暴露,立即撤销并生成新密钥
故障排除
- “ 无效或已过期
- 缺少
Authorization请求头 - Bearer token 格式不正确
- 将旧版 “ (
apk_/apk_user_) 与 Devin MCP 一起使用——仅支持带有cog_前缀的密钥
是否正确,并确保在 `Authorization` 请求头中按要求正确填写和格式化。对于 MCP 的使用,请确保你使用的是服务用户 (而非旧版密钥) 。
403 禁止访问
- API key 不具有所需权限
- 针对该 endpoint 使用了错误的 key 类型 (例如,用旧版 key 调用 v3 端点)
- 尝试访问超出你授权范围的资源
- 确认你的服务用户具备正确的角色和权限
- 对于旧版 v2 端点:确认你拥有 Enterprise 管理员角色
- 对于旧版 v1 端点:核实你是否有该组织的访问权限
404 未找到
- API 端点 URL 不正确
- 资源不存在,或你没有访问权限
后续步骤
- Teams 快速入门 — 几分钟内上手
- Enterprise 快速入门 — RBAC 和多组织架构配置
- 常见流程 — 端到端工作流程示例
- 迁移指南 — 从 v1/v2 迁移

