Technical reference
SecretRef 認証情報サーフェス
このページでは、正規の SecretRef 認証情報サーフェス、つまり生のシークレット値の代わりに SecretRef(環境変数/ファイル/exec を基盤とする参照)を受け入れる認証情報フィールドを定義します。
対象範囲:
- 対象:OpenClaw が発行もローテーションもしない、厳密にユーザー指定の認証情報。
- 対象外:実行時に発行される認証情報またはローテーションされる認証情報、OAuth 更新用データ、セッションに類するアーティファクト。
以下のリストはソースのターゲットレジストリから生成され、CI で docs/reference/secretref-user-supplied-credentials-matrix.json と照合されます。エントリを手動で編集しないでください。
サポートされる認証情報
openclaw.json ターゲット(secrets configure + secrets apply + secrets audit)
models.providers.*.apiKeymodels.providers.*.headers.*models.providers.*.request.auth.tokenmodels.providers.*.request.auth.valuemodels.providers.*.request.headers.*models.providers.*.request.proxy.tls.camodels.providers.*.request.proxy.tls.certmodels.providers.*.request.proxy.tls.keymodels.providers.*.request.proxy.tls.passphrasemodels.providers.*.request.tls.camodels.providers.*.request.tls.certmodels.providers.*.request.tls.keymodels.providers.*.request.tls.passphraseskills.entries.*.apiKeyagents.defaults.memorySearch.remote.apiKeyagents.list[].tts.providers.*.apiKeyagents.list[].memorySearch.remote.apiKeytalk.providers.*.apiKeytalk.realtime.providers.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.acpx.config.mcpServers.*.env.*plugins.entries.brave.config.webSearch.apiKeyplugins.entries.codex.config.appServer.authTokenplugins.entries.codex.config.appServer.headers.*plugins.entries.exa.config.webSearch.apiKeyplugins.entries.google-meet.config.realtime.providers.*.apiKeyplugins.entries.google.config.webSearch.apiKeyplugins.entries.xai.config.webSearch.apiKeyplugins.entries.moonshot.config.webSearch.apiKeyplugins.entries.perplexity.config.webSearch.apiKeyplugins.entries.firecrawl.config.webSearch.apiKeyplugins.entries.minimax.config.webSearch.apiKeyplugins.entries.tavily.config.webSearch.apiKeyplugins.entries.parallel.config.webSearch.apiKeyplugins.entries.voice-call.config.realtime.providers.*.apiKeyplugins.entries.voice-call.config.streaming.providers.*.apiKeyplugins.entries.voice-call.config.tts.providers.*.apiKeyplugins.entries.voice-call.config.twilio.authTokentools.web.search.*.apiKeytools.web.search.apiKeygateway.auth.passwordgateway.auth.tokengateway.remote.tokengateway.remote.passwordcron.webhookTokenchannels.telegram.botTokenchannels.telegram.webhookSecretchannels.telegram.accounts.*.botTokenchannels.telegram.accounts.*.webhookSecretchannels.slack.botTokenchannels.slack.appTokenchannels.slack.relay.authTokenchannels.slack.userTokenchannels.slack.signingSecretchannels.slack.accounts.*.botTokenchannels.slack.accounts.*.appTokenchannels.slack.accounts.*.relay.authTokenchannels.slack.accounts.*.userTokenchannels.slack.accounts.*.signingSecretchannels.sms.authTokenchannels.sms.accounts.*.authTokenchannels.discord.tokenchannels.discord.pluralkit.tokenchannels.discord.voice.tts.providers.*.apiKeychannels.discord.accounts.*.tokenchannels.discord.accounts.*.pluralkit.tokenchannels.discord.accounts.*.voice.tts.providers.*.apiKeychannels.irc.passwordchannels.irc.nickserv.passwordchannels.irc.accounts.*.passwordchannels.irc.accounts.*.nickserv.passwordchannels.feishu.appSecretchannels.feishu.encryptKeychannels.feishu.verificationTokenchannels.feishu.accounts.*.appSecretchannels.feishu.accounts.*.encryptKeychannels.feishu.accounts.*.verificationTokenchannels.qqbot.clientSecretchannels.qqbot.accounts.*.clientSecretchannels.msteams.appPasswordchannels.mattermost.botTokenchannels.mattermost.accounts.*.botTokenchannels.matrix.accessTokenchannels.matrix.passwordchannels.matrix.accounts.*.accessTokenchannels.matrix.accounts.*.passwordchannels.nextcloud-talk.botSecretchannels.nextcloud-talk.apiPasswordchannels.nextcloud-talk.accounts.*.botSecretchannels.nextcloud-talk.accounts.*.apiPasswordchannels.zalo.botTokenchannels.zalo.webhookSecretchannels.zalo.accounts.*.botTokenchannels.zalo.accounts.*.webhookSecretchannels.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.*です。
サポートされない認証情報
これらの認証情報は、発行、ローテーション、セッション保持、または OAuth の永続データに該当し、読み取り専用の外部 SecretRef 解決には適合しません。
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
関連項目
Was this useful?