Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.kr/llms.txt
Use this file to discover all available pages before exploring further.
OAuth
OpenClaw 通过 OAuth 支持提供商提供的“订阅认证”,适用于支持此方式的提供商(尤其是 OpenAI Codex(ChatGPT OAuth))。对于 Anthropic 订阅,请使用 setup-token 流程。过去有些用户在 Claude Code 之外使用 Anthropic 订阅时曾受限,因此这应视为用户自行选择承担的风险,你应自行核实 Anthropic 当前的政策。OpenAI Codex OAuth 明确支持在 OpenClaw 这样的外部工具中使用。本页说明: 对于生产环境中的 Anthropic,相比订阅 setup-token 认证,API 密钥认证是更安全、也更推荐的路径。- OAuth 令牌交换 如何工作(PKCE)
- 令牌存储在哪里(以及为什么)
- 如何处理多个账户(配置文件 + 按会话覆盖)
令牌汇点(为什么需要它)
OAuth 提供商通常会在登录/刷新流程中签发一个新的刷新令牌。某些提供商(或 OAuth 客户端)会在为同一用户/应用签发新令牌时使旧的刷新令牌失效。 实际症状:- 你同时通过 OpenClaw 和 Claude Code / Codex CLI 登录 → 之后其中一个会随机“被登出”
auth-profiles.json 视为一个令牌汇点:
- 运行时从同一个地方读取凭证
- 我们可以保留多个配置文件,并进行确定性路由
存储(令牌存放位置)
密钥按每个智能体存储:- 认证配置文件(OAuth + API 密钥 + 可选的值级引用):
~/.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。
Anthropic setup-token(订阅认证)
在任意机器上运行claude setup-token,然后将其粘贴到 OpenClaw 中:
OAuth 交换(登录如何工作)
OpenClaw 的交互式登录流程在@mariozechner/pi-ai 中实现,并接入到各类向导/命令中。
Anthropic setup-token
流程形态:- 运行
claude setup-token - 将令牌粘贴到 OpenClaw
- 存储为令牌认证配置文件(不刷新)
openclaw onboard → 认证选择 setup-token(Anthropic)。
OpenAI Codex(ChatGPT OAuth)
OpenAI Codex OAuth 明确支持在 Codex CLI 之外使用,包括 OpenClaw 工作流。 流程形态(PKCE):- 生成 PKCE verifier/challenge 和随机
state - 打开
https://auth.openai.com/oauth/authorize?... - 尝试在
http://127.0.0.1:1455/auth/callback捕获回调 - 如果回调无法绑定(或你是在远程/无头环境中),则粘贴重定向 URL/code
- 在
https://auth.openai.com/oauth/token交换令牌 - 从访问令牌中提取
accountId并存储{ access, refresh, expires, accountId }
openclaw onboard → 认证选择 openai-codex。
刷新和过期
配置文件会存储一个expires 时间戳。
在运行时:
- 如果
expires尚未到期 → 使用已存储的访问令牌 - 如果已过期 → 在文件锁下刷新,并覆盖已存储的凭证
多个账户(配置文件)+ 路由
有两种模式:1)推荐:分离的智能体
如果你希望“个人”和“工作”永不交叉,请使用隔离的智能体(独立的会话 + 凭证 + 工作区):2)高级:单个智能体中的多个配置文件
auth-profiles.json 支持同一提供商下的多个配置文件 ID。
选择使用哪个配置文件:
- 通过配置排序全局选择(
auth.order) - 通过
/model ...@<profileId>按会话选择
/model Opus@anthropic:work
openclaw channels list --json(显示auth[])
- /concepts/model-failover(轮换 + 冷却规则)
- /tools/slash-commands(命令入口)