Skip to content
OpenClaw Docs

SecretRef 憑證範圍

本頁面定義了標準的 SecretRef 憑證範圍。

範圍意圖：

  • 範圍內：嚴格由使用者提供的憑證，且 OpenClaw 不會產生或輪換這些憑證。
  • 範圍外：執行時期產生或輪換的憑證、OAuth 更新材料，以及類似階段的資料。

支援的憑證

Section titled “支援的憑證”

openclaw.json 目標 (secrets configure + secrets apply + secrets audit)

Section titled “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
  • 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.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
  • 透過同層級 serviceAccountRef 的 channels.googlechat.serviceAccount（相容性例外）
  • 透過同層級 serviceAccountRef 的 channels.googlechat.accounts.*.serviceAccount（相容性例外）

auth-profiles.json 目標 (secrets configure + secrets apply + secrets audit)

Section titled “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" 時不支援)

備註：

  • Auth-profile 計劃目標需要 agentId。
  • 計劃條目目標 profiles.*.key / profiles.*.token 並寫入同級 refs (keyRef / tokenRef)。
  • Auth-profile refs 包含在執行時期解析和稽核覆蓋範圍內。
  • 在 openclaw.json 中，SecretRefs 必須使用結構化物件，例如 {"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}。舊版 secretref-env:<ENV_VAR> 標記字串會在 SecretRef 憑證路徑上被拒絕；請執行 openclaw doctor --fix 以遷移有效的標記。
  • OAuth 策略防護：auth.profiles.<id>.mode = "oauth" 無法與該設定檔的 SecretRef 輸入結合。當違反此策略時，啟動/重新載入和 auth-profile 解析會快速失敗。
  • 對於由 SecretRef 管理的模型提供者，產生的 agents/*/agent/models.json 條目會為 apiKey/header 介面保存非機密標記（非已解析的機密值）。
  • 標記持久化是以來源為權威：OpenClaw 從作用中的來源設定快照（解析前）寫入標記，而不是從已解析的執行時期機密值寫入。
  • 對於網路搜尋：
    • 在明確提供者模式（已設定 tools.web.search.provider）中，只有選定的提供者金鑰是作用中的。
    • 在自動模式（未設定 tools.web.search.provider）中，只有第一個依優先順序解析的提供者金鑰是作用中的。
    • 在自動模式下，非選定的提供者 refs 在被選定之前會被視為非作用中。
    • 舊版 tools.web.search.* 提供者路徑在相容視窗期間仍可解析，但標準的 SecretRef 介面是 plugins.entries.<plugin>.config.webSearch.*。

不支援的憑證

Section titled “不支援的憑證”

範圍外的憑證包括：

  • 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 解析。

相關

Section titled “相關”