メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

このページは、正準 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.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)

  • profiles.*.keyRef (type: "api_key"; auth.profiles.<id>.mode = "oauth" の場合はサポート対象外)
  • profiles.*.tokenRef (type: "token"; auth.profiles.<id>.mode = "oauth" の場合はサポート対象外)
注記:
  • 認証プロファイルのプランターゲットには agentId が必要です。
  • プランエントリは profiles.*.key / profiles.*.token を対象にし、兄弟 ref (keyRef / tokenRef) を書き込みます。
  • 認証プロファイルの ref は、実行時の解決と監査カバレッジに含まれます。
  • 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 入力と組み合わせることはできません。このポリシーに違反した場合、起動/再読み込みと認証プロファイル解決は即座に失敗します。
  • SecretRef 管理のモデルプロバイダーでは、生成される agents/*/agent/models.json エントリは apiKey/ヘッダーサーフェスについて、シークレット値を解決したものではなく、非シークレットのマーカーを保持します。
  • マーカーの永続化はソース権威です。OpenClaw は、解決済みの実行時シークレット値ではなく、アクティブなソース設定スナップショット（解決前）からマーカーを書き込みます。
  • ウェブ検索について:
    • 明示的なプロバイダーモード (tools.web.search.provider が設定済み) では、選択されたプロバイダーキーのみが有効です。
    • 自動モード (tools.web.search.provider が未設定) では、優先順位に従って解決される最初のプロバイダーキーのみが有効です。
    • 自動モードでは、選択されていないプロバイダー ref は、選択されるまで非アクティブとして扱われます。
    • レガシーの 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 解決には適合しません。

​
関連