Technical reference

Інтерфейс облікових даних 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 SecretRefs мають використовувати структуровані об’єкти, як-от {"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Застарілі рядки-маркери secretref-env:&lt;ENV_VAR&gt; відхиляються на шляхах облікових даних 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.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 лише для читання.

Пов’язане