Technical reference
Поверхность учётных данных SecretRef
Эта страница определяет каноническую область учётных данных SecretRef: какие поля учётных данных принимают SecretRef (ссылку на основе переменной окружения, файла или выполнения команды) вместо необработанного значения секрета.
Область действия:
- Входит в область действия: исключительно предоставляемые пользователем учётные данные, которые OpenClaw не выпускает и не ротирует.
- Не входит в область действия: выпускаемые во время выполнения или ротируемые учётные данные, материалы обновления OAuth и артефакты, подобные сеансовым.
Приведённые ниже списки создаются из исходного реестра целей и сверяются с docs/reference/secretref-user-supplied-credentials-matrix.json в CI; не редактируйте записи вручную.
Поддерживаемые учётные данные
Цели 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 записывает маркеры из активного снимка исходной конфигурации (до разрешения), а не из разрешённых значений секретов среды выполнения. - Для веб-поиска: в режиме явно заданного провайдера (задан
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?