Permukaan kredensial SecretRef
Halaman ini mendefinisikan permukaan kredensial SecretRef yang kanonis. Maksud cakupan:- Termasuk dalam cakupan: kredensial yang secara ketat disediakan pengguna dan tidak dibuat atau diputar oleh OpenClaw.
- Di luar cakupan: kredensial yang dibuat saat runtime atau berputar, materi refresh OAuth, dan artefak mirip sesi.
Kredensial yang didukung
Target 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[].memorySearch.remote.apiKeytalk.providers.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.firecrawl.config.webFetch.apiKeyplugins.entries.brave.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.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.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.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.serviceAccountviaserviceAccountRefsaudara (pengecualian kompatibilitas)channels.googlechat.accounts.*.serviceAccountviaserviceAccountRefsaudara (pengecualian kompatibilitas)
Target auth-profiles.json (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; tidak didukung saatauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; tidak didukung saatauth.profiles.<id>.mode = "oauth")
- Target paket auth-profile memerlukan
agentId. - Entri paket menargetkan
profiles.*.key/profiles.*.tokendan menulis ref saudara (keyRef/tokenRef). - Ref auth-profile disertakan dalam resolusi runtime dan cakupan audit.
- Guard kebijakan OAuth:
auth.profiles.<id>.mode = "oauth"tidak dapat digabungkan dengan input SecretRef untuk profil tersebut. Startup/reload dan resolusi auth-profile gagal cepat saat kebijakan ini dilanggar. - Untuk model provider yang dikelola SecretRef, entri
agents/*/agent/models.jsonyang dihasilkan menyimpan penanda non-rahasia (bukan nilai rahasia yang telah diresolusikan) untuk permukaanapiKey/header. - Persistensi penanda bersifat source-authoritative: OpenClaw menulis penanda dari snapshot konfigurasi sumber yang aktif (pra-resolusi), bukan dari nilai rahasia runtime yang telah diresolusikan.
- Untuk pencarian web:
- Dalam mode provider eksplisit (
tools.web.search.providerdisetel), hanya kunci provider yang dipilih yang aktif. - Dalam mode otomatis (
tools.web.search.providertidak disetel), hanya kunci provider pertama yang teresolusi berdasarkan prioritas yang aktif. - Dalam mode otomatis, ref provider yang tidak dipilih diperlakukan sebagai tidak aktif sampai dipilih.
- Jalur provider lama
tools.web.search.*masih diresolusikan selama jendela kompatibilitas, tetapi permukaan SecretRef yang kanonis adalahplugins.entries.<plugin>.config.webSearch.*.
- Dalam mode provider eksplisit (
Kredensial yang tidak didukung
Kredensial di luar cakupan mencakup:commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
- Kredensial ini termasuk kelas yang dibuat, diputar, membawa sesi, atau tahan lama OAuth yang tidak cocok untuk resolusi SecretRef eksternal read-only.