OpenClaw 🦞

SecretRef 凭证表面

SecretRef 凭证表面

本页面定义了规范的 SecretRef 凭证表面。

范围意图：

  • 范围内：严格的用户提供的凭证，OpenClaw 不铸造或轮换。
  • 范围外：运行时铸造或轮换的凭证、OAuth 刷新材料和会话类工件。

支持的凭证

openclaw.json 目标（secrets configure + secrets apply + secrets audit）

  • models.providers.*.apiKey
  • skills.entries.*.apiKey
  • agents.defaults.memorySearch.remote.apiKey
  • agents.list[].memorySearch.remote.apiKey
  • talk.apiKey
  • talk.providers.*.apiKey
  • messages.tts.elevenlabs.apiKey
  • messages.tts.openai.apiKey
  • tools.web.search.apiKey
  • tools.web.search.gemini.apiKey
  • tools.web.search.grok.apiKey
  • tools.web.search.kimi.apiKey
  • tools.web.search.perplexity.apiKey
  • gateway.auth.password
  • gateway.remote.token
  • gateway.remote.password
  • cron.webhookToken
  • channels.telegram.botToken
  • channels.telegram.webhookSecret
  • channels.telegram.accounts.*.botToken
  • channels.telegram.accounts.*.webhookSecret
  • channels.slack.botToken
  • channels.slack.appToken
  • channels.slack.userToken
  • channels.slack.signingSecret
  • channels.slack.accounts.*.botToken
  • channels.slack.accounts.*.appToken
  • channels.slack.accounts.*.userToken
  • channels.slack.accounts.*.signingSecret
  • channels.discord.token
  • channels.discord.pluralkit.token
  • channels.discord.voice.tts.elevenlabs.apiKey
  • channels.discord.voice.tts.openai.apiKey
  • channels.discord.accounts.*.token
  • channels.discord.accounts.*.pluralkit.token
  • channels.discord.accounts.*.voice.tts.elevenlabs.apiKey
  • channels.discord.accounts.*.voice.tts.openai.apiKey
  • channels.irc.password
  • channels.irc.nickserv.password
  • channels.irc.accounts.*.password
  • channels.irc.accounts.*.nickserv.password
  • channels.bluebubbles.password
  • channels.bluebubbles.accounts.*.password
  • channels.feishu.appSecret
  • channels.feishu.verificationToken
  • channels.feishu.accounts.*.appSecret
  • channels.feishu.accounts.*.verificationToken
  • channels.msteams.appPassword
  • channels.mattermost.botToken
  • channels.mattermost.accounts.*.botToken
  • channels.matrix.password
  • channels.matrix.accounts.*.password
  • channels.nextcloud-talk.botSecret
  • channels.nextcloud-talk.apiPassword
  • channels.nextcloud-talk.accounts.*.botSecret
  • channels.nextcloud-talk.accounts.*.apiPassword
  • channels.zalo.botToken
  • channels.zalo.webhookSecret
  • channels.zalo.accounts.*.botToken
  • channels.zalo.accounts.*.webhookSecret
  • channels.googlechat.serviceAccount 通过兄弟 serviceAccountRef（兼容性例外）
  • channels.googlechat.accounts.*.serviceAccount 通过兄弟 serviceAccountRef（兼容性例外）

auth-profiles.json 目标（secrets configure + secrets apply + secrets audit）

  • profiles.*.keyRef（type: "api_key"）
  • profiles.*.tokenRef（type: "token"）

注意：

  • 认证配置文件计划目标需要 agentId。
  • 计划条目目标 profiles.*.key / profiles.*.token 并写入兄弟引用（keyRef / tokenRef）。
  • 认证配置文件引用包含在运行时解析和审计覆盖中。
  • 对于 Web 搜索：
    • 在显式提供商模式（tools.web.search.provider 设置）中，只有选定的提供商密钥处于活动状态。
    • 在自动模式（tools.web.search.provider 未设置）中，tools.web.search.apiKey 和提供商特定密钥处于活动状态。

不支持的凭证

范围外的凭证包括：

  • gateway.auth.token
  • commands.ownerDisplaySecret
  • channels.matrix.accessToken
  • channels.matrix.accounts.*.accessToken
  • hooks.token
  • hooks.gmail.pushToken
  • hooks.mappings[].sessionKey
  • auth-profiles.oauth.*
  • discord.threadBindings.*.webhookToken
  • whatsapp.creds.json

理由：

  • 这些凭证是铸造的、轮换的、携带会话的或 OAuth 持久类，不适合只读外部 SecretRef 解析。