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.*.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")
Примечания:
- Целевые элементы плана auth-profile требуют
agentId. - Записи плана нацеливаются на
profiles.*.key/profiles.*.tokenи записывают соседние ссылки (keyRef/tokenRef). - Ссылки auth-profile включены в разрешение во время выполнения и покрытие аудита.
- В
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 для этого профиля. Запуск/перезагрузка и разрешение auth-profile быстро завершаются ошибкой при нарушении этой политики. - Для поставщиков моделей, управляемых 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 и не подходят для read-only внешнего разрешения SecretRef.
Связанные материалы
Was this useful?