Technical reference
Surface d’identifiants SecretRef
Cette page définit la surface d’identifiants SecretRef canonique.
Intention du périmètre :
- Dans le périmètre : identifiants strictement fournis par l’utilisateur, qu’OpenClaw n’émet ni ne renouvelle.
- Hors périmètre : identifiants émis ou renouvelés par l’environnement d’exécution, matériel de rafraîchissement OAuth et artefacts de type session.
Identifiants pris en charge
Cibles 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.serviceAccountvia le frèreserviceAccountRef(exception de compatibilité)channels.googlechat.accounts.*.serviceAccountvia le frèreserviceAccountRef(exception de compatibilité)
Cibles auth-profiles.json (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; non pris en charge lorsqueauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; non pris en charge lorsqueauth.profiles.<id>.mode = "oauth")
Remarques :
- Les cibles de plan de profil d’authentification nécessitent
agentId. - Les entrées de plan ciblent
profiles.*.key/profiles.*.tokenet écrivent les refs frères (keyRef/tokenRef). - Les refs de profil d’authentification sont incluses dans la résolution à l’exécution et dans la couverture d’audit.
- Dans
openclaw.json, les SecretRefs doivent utiliser des objets structurés tels que{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Les chaînes de marqueur héritéessecretref-env:<ENV_VAR>sont rejetées sur les chemins d’identifiants SecretRef ; exécutezopenclaw doctor --fixpour migrer les marqueurs valides. - Garde de politique OAuth :
auth.profiles.<id>.mode = "oauth"ne peut pas être combiné avec des entrées SecretRef pour ce profil. Le démarrage/rechargement et la résolution de profil d’authentification échouent immédiatement lorsque cette politique est violée. - Pour les fournisseurs de modèles gérés par SecretRef, les entrées
agents/*/agent/models.jsongénérées conservent des marqueurs non secrets (pas des valeurs secrètes résolues) pour les surfacesapiKey/en-têtes. - La persistance des marqueurs fait autorité sur la source : OpenClaw écrit les marqueurs depuis l’instantané de configuration source actif (avant résolution), pas depuis les valeurs secrètes résolues à l’exécution.
- Pour la recherche web :
- En mode fournisseur explicite (
tools.web.search.providerdéfini), seule la clé du fournisseur sélectionné est active. - En mode automatique (
tools.web.search.providernon défini), seule la première clé de fournisseur résolue par ordre de priorité est active. - En mode automatique, les refs de fournisseurs non sélectionnés sont traitées comme inactives jusqu’à leur sélection.
- Les chemins de fournisseurs hérités
tools.web.search.*sont toujours résolus pendant la fenêtre de compatibilité, mais la surface SecretRef canonique estplugins.entries.<plugin>.config.webSearch.*.
- En mode fournisseur explicite (
Identifiants non pris en charge
Les identifiants hors périmètre incluent :
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Justification :
- Ces identifiants relèvent de classes émises, renouvelées, porteuses de session ou durables OAuth qui ne correspondent pas à la résolution SecretRef externe en lecture seule.
Associé
Was this useful?