Technical reference
Інтерфейс облікових даних SecretRef
Ця сторінка визначає канонічну поверхню облікових даних SecretRef.
Мета області дії:
- Входить до області: суворо надані користувачем облікові дані, які OpenClaw не створює й не ротує.
- Поза областю: створені під час виконання або ротаційні облікові дані, матеріали оновлення OAuth та артефакти на кшталт сеансів.
Підтримувані облікові дані
Цілі 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.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.acpx.config.mcpServers.*.env.*plugins.entries.brave.config.webSearch.apiKeyplugins.entries.exa.config.webSearch.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.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.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.userTokenchannels.slack.signingSecretchannels.slack.accounts.*.botTokenchannels.slack.accounts.*.appTokenchannels.slack.accounts.*.userTokenchannels.slack.accounts.*.signingSecretchannels.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.bluebubbles.passwordchannels.bluebubbles.accounts.*.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.jsonSecretRefs мають використовувати структуровані об’єкти, як-от{"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не встановлено) активним є лише перший ключ провайдера, який розв’язується за пріоритетом. - В автоматичному режимі посилання невибраних провайдерів вважаються неактивними, доки їх не вибрано.
- Застарілі шляхи провайдерів
tools.web.search.*усе ще розв’язуються протягом вікна сумісності, але канонічною поверхнею SecretRef єplugins.entries.<plugin>.config.webSearch.*.
- У режимі явного провайдера (коли встановлено
Непідтримувані облікові дані
Облікові дані поза областю включають:
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Обґрунтування:
- Ці облікові дані належать до класів, що створюються, ротуються, несуть стан сеансу або довгостроково використовуються OAuth, і не відповідають моделі зовнішнього розв’язання SecretRef лише для читання.