跳转到内容

OAuth

对于提供 OAuth 的提供商(特别是 OpenAI Codex (ChatGPT OAuth)),OpenClaw 支持通过 OAuth 进行“订阅认证”。对于 Anthropic,目前的实际划分是:

  • Anthropic API 密钥:正常的 Anthropic API 计费
  • OpenClaw 内部的 Anthropic Claude CLI / 订阅认证:Anthropic 员工告诉我们这种用法再次被允许了

OpenAI Codex OAuth 明确支持在外部工具(如 OpenClaw)中使用。本页面解释了:

对于生产环境中的 Anthropic,API 密钥认证是更安全的推荐路径。

  • OAuth 令牌交换 是如何工作的 (PKCE)
  • 令牌存储在何处(以及原因)
  • 如何处理多个账户(配置文件 + 每次会话覆盖)

OpenClaw 还支持自带的 OAuth 或 API 密钥流程的提供商插件。通过以下方式运行它们:

Terminal window
openclaw models auth login --provider <id>

OAuth 提供商通常会在登录/刷新期间生成一个新的刷新令牌。当为同一用户/应用颁发新令牌时,某些提供商(或 OAuth 客户端)可能会使旧的刷新令牌失效。

实际表现症状:

  • 你通过 OpenClaw 以及 Claude Code / Codex CLI 登录 → 其中一个稍后会随机“注销”

为了减少这种情况,OpenClaw 将 auth-profiles.json 视为令牌汇聚

  • 运行时从一个地方读取凭据
  • 我们可以保留多个配置文件并确定性地路由它们
  • 外部 CLI 复用因 CLI 而异:Codex OpenClaw 可以引导一个空的 openai-codex:default 配置文件,但一旦 OAuth 拥有本地 OpenClaw 配置文件, 本地刷新令牌即为准绳。如果本地刷新令牌被拒绝, CLI 可以使用可用的同账户 Codex CLI 令牌作为仅运行时 回退;其他集成可以保持外部管理,并重新读取其 CLI 身份验证存储
  • 已知已配置提供商集的状态和启动路径将外部 CLI 发现范围限制在该集内,因此对于单提供商设置,不会探测无关的 CLI 登录存储

密钥存储在代理认证存储中:

  • 认证配置文件(OAuth + API 密钥 + 可选的值级引用):OAuthAPI~/.openclaw/agents/<agentId>/agent/auth-profiles.json
  • 旧版兼容性文件:~/.openclaw/agents/<agentId>/agent/auth.json (发现时会清除静态 api_key 条目)

旧版仅导入文件(仍受支持,但不是主存储):

  • ~/.openclaw/credentials/oauth.json(首次使用时导入到 auth-profiles.json

上述所有内容也遵循 $OPENCLAW_STATE_DIR(状态目录覆盖)。完整参考:/gateway/configuration

关于静态机密引用和运行时快照激活行为,请参阅 Secrets Management

当辅助代理没有本地认证配置文件时,OpenClaw 会使用来自默认/主代理存储的读通继承。它在读取时不会克隆主代理的 OpenClawauth-profiles.jsonOAuthOAuth。OAuth 刷新令牌尤其敏感:正常的复制流程默认会跳过它们,因为某些提供商在使用后会轮换或使刷新令牌失效。当代理需要独立账户时,请为其配置单独的 OAuth 登录。

OpenClaw 还公开了 Anthropic 设置令牌 (setup-token) 作为受支持的令牌身份验证路径,但现在在可用时,它更倾向于重用 Claude CLI 和 claude -p

OpenClaw 再次支持重用 Anthropic Claude CLI。如果您在主机上已有本地 Claude 登录信息,新手引导/configure 可以直接重用它。

OpenClaw 的交互式登录流程在 @earendil-works/pi-ai 中实现,并连接到向导/命令中。

流程形式:

  1. 从 Anthropic 启动 OpenClaw 设置令牌或粘贴令牌
  2. OpenClaw 将生成的 Anthropic 凭据存储在身份验证配置文件中
  3. 模型选择保持在 anthropic/...
  4. 现有的 Anthropic 身份验证配置文件仍可用于回滚/顺序控制

OpenAI Codex OAuth 明确支持在 Codex CLI 之外使用,包括 OpenClaw 工作流。

流程形状 (PKCE):

  1. 生成 PKCE 验证器/挑战 + 随机 state
  2. 打开 https://auth.openai.com/oauth/authorize?...
  3. 尝试在 http://127.0.0.1:1455/auth/callback 上捕获回调
  4. 如果回调无法绑定(或者您处于远程/无头模式),请粘贴重定向 URL/代码
  5. https://auth.openai.com/oauth/token 进行交换
  6. 从访问令牌中提取 accountId 并存储 { access, refresh, expires, accountId }

向导路径为 openclaw onboard → 身份验证选择 openai-codex

配置文件存储一个 expires 时间戳。

运行时:

  • 如果 expires 在未来 → 使用存储的访问令牌
  • 如果已过期 → 刷新(在文件锁下)并覆盖存储的凭据
  • 如果辅助代理读取继承的主代理 OAuth 配置文件,刷新操作将写回主代理存储,而不是将刷新令牌复制到辅助代理存储中
  • 例外:某些外部 CLI 凭据保持外部管理;OpenClaw 会重新读取这些 CLI 认证存储,而不是消耗已复制的刷新令牌。Codex CLI 引导的范围有意更窄:它会植入一个空的 CLIOpenClawCLICLIopenai-codex:defaultOpenClawCLIOpenClaw 配置文件,然后由 OpenClaw 拥有的刷新操作使本地配置文件保持权威状态。如果本地 Codex 刷新失败,且 Codex CLI 拥有同一账户的有效令牌,OpenClaw 可能会在当前的运行时请求中使用该令牌,而不会将其写回 auth-profiles.json

刷新流程是自动的;您通常不需要手动管理令牌。

两种模式:

如果您希望“个人”和“工作”互不干扰,请使用隔离的代理(独立的会话 + 凭据 + 工作区):

Terminal window
openclaw agents add work
openclaw agents add personal

然后为每个代理配置身份验证(向导)并将聊天路由到正确的代理。

2) 高级:一个代理中的多个配置文件

Section titled “2) 高级:一个代理中的多个配置文件”

auth-profiles.json 支持同一提供商的多个配置文件 ID。

选择使用哪个配置文件:

  • 通过配置排序全局设置 (auth.order)
  • 通过 /model ...@<profileId> 按会话设置

示例(会话覆盖):

  • /model Opus@anthropic:work

如何查看存在哪些配置文件 ID:

  • openclaw channels list --json(显示 auth[]

相关文档: