SecretRef 凭证接口面

此页面定义规范的 SecretRef 凭据接口面。

范围意图：

• 范围内：严格限于用户提供的、OpenClaw 不签发也不轮换的凭据。
• 范围外：运行时签发或轮换的凭据、OAuth 刷新材料，以及类似会话的构件。

# 支持的凭据

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

• models.providers.*.apiKey
• models.providers.*.headers.*
• models.providers.*.request.auth.token
• models.providers.*.request.auth.value
• models.providers.*.request.headers.*
• models.providers.*.request.proxy.tls.ca
• models.providers.*.request.proxy.tls.cert
• models.providers.*.request.proxy.tls.key
• models.providers.*.request.proxy.tls.passphrase
• models.providers.*.request.tls.ca
• models.providers.*.request.tls.cert
• models.providers.*.request.tls.key
• models.providers.*.request.tls.passphrase
• skills.entries.*.apiKey
• agents.defaults.memorySearch.remote.apiKey
• agents.list[].tts.providers.*.apiKey
• agents.list[].memorySearch.remote.apiKey
• talk.providers.*.apiKey
• messages.tts.providers.*.apiKey
• tools.web.fetch.firecrawl.apiKey
• plugins.entries.acpx.config.mcpServers.*.env.*
• plugins.entries.brave.config.webSearch.apiKey
• plugins.entries.exa.config.webSearch.apiKey
• plugins.entries.google.config.webSearch.apiKey
• plugins.entries.xai.config.webSearch.apiKey
• plugins.entries.moonshot.config.webSearch.apiKey
• plugins.entries.perplexity.config.webSearch.apiKey
• plugins.entries.firecrawl.config.webSearch.apiKey
• plugins.entries.minimax.config.webSearch.apiKey
• plugins.entries.tavily.config.webSearch.apiKey
• plugins.entries.voice-call.config.realtime.providers.*.apiKey
• plugins.entries.voice-call.config.streaming.providers.*.apiKey
• plugins.entries.voice-call.config.tts.providers.*.apiKey
• plugins.entries.voice-call.config.twilio.authToken
• tools.web.search.apiKey
• gateway.auth.password
• gateway.auth.token
• 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.providers.*.apiKey
• channels.discord.accounts.*.token
• channels.discord.accounts.*.pluralkit.token
• channels.discord.accounts.*.voice.tts.providers.*.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.encryptKey
• channels.feishu.verificationToken
• channels.feishu.accounts.*.appSecret
• channels.feishu.accounts.*.encryptKey
• channels.feishu.accounts.*.verificationToken
• channels.qqbot.clientSecret
• channels.qqbot.accounts.*.clientSecret
• channels.msteams.appPassword
• channels.mattermost.botToken
• channels.mattermost.accounts.*.botToken
• channels.matrix.accessToken
• channels.matrix.password
• channels.matrix.accounts.*.accessToken
• 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"；当 auth.profiles.<id>.mode = "oauth" 时不支持）
• profiles.*.tokenRef（type: "token"；当 auth.profiles.<id>.mode = "oauth" 时不支持）

说明：

• 身份验证配置文件计划目标需要 agentId。
• 计划条目以 profiles.*.key / profiles.*.token 为目标，并写入同级引用（keyRef / tokenRef）。
• 身份验证配置文件引用包含在运行时解析和审计覆盖范围中。
• 在 openclaw.json 中，SecretRef 必须使用结构化对象，例如 {"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}。旧版 secretref-env:<ENV_VAR> 标记字符串在 SecretRef 凭据路径上会被拒绝；运行 openclaw doctor --fix 以迁移有效标记。
• OAuth 策略保护：auth.profiles.<id>.mode = "oauth" 不能与该配置文件的 SecretRef 输入组合使用。违反此策略时，启动/重新加载和身份验证配置文件解析会快速失败。
• 对于由 SecretRef 管理的模型提供商，生成的 agents/*/agent/models.json 条目会为 apiKey/标头接口面持久化非密钥标记（而不是已解析的密钥值）。
• 标记持久化以来源为权威：OpenClaw 会从活动源配置快照（解析前）写入标记，而不是从已解析的运行时密钥值写入。
• 对于 Web 搜索：
  • 在显式提供商模式下（设置了 tools.web.search.provider），只有所选提供商键处于活动状态。
  • 在自动模式下（未设置 tools.web.search.provider），只有按优先级解析到的第一个提供商键处于活动状态。
  • 在自动模式下，未选中的提供商引用在被选中前会被视为非活动。
  • 旧版 tools.web.search.* 提供商路径在兼容性窗口期内仍会解析，但规范的 SecretRef 接口面是 plugins.entries.<plugin>.config.webSearch.*。

# 不支持的凭据

范围外凭据包括：

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

原因：

• 这些凭据属于已签发、已轮换、带会话属性或 OAuth 持久化类别，不适合只读外部 SecretRef 解析。

# 相关

• 密钥管理
• 身份验证凭据语义