Technical reference
SecretRef-Schnittstelle für Anmeldedaten
Diese Seite definiert die kanonische SecretRef-Oberfläche für Anmeldedaten.
Ziel des Geltungsbereichs:
- Im Geltungsbereich: ausschließlich vom Benutzer bereitgestellte Anmeldedaten, die OpenClaw nicht ausstellt oder rotiert.
- Nicht im Geltungsbereich: zur Laufzeit ausgestellte oder rotierende Anmeldedaten, OAuth-Refresh-Material und sitzungsähnliche Artefakte.
Unterstützte Anmeldedaten
openclaw.json-Ziele (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.*.apiKeymessages.tts.providers.*.apiKeytools.web.fetch.firecrawl.apiKeyplugins.entries.acpx.config.mcpServers.*.env.*plugins.entries.brave.config.webSearch.apiKeyplugins.entries.exa.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.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.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.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über gleichrangigesserviceAccountRef(Kompatibilitätsausnahme)channels.googlechat.accounts.*.serviceAccountüber gleichrangigesserviceAccountRef(Kompatibilitätsausnahme)
auth-profiles.json-Ziele (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; nicht unterstützt, wennauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; nicht unterstützt, wennauth.profiles.<id>.mode = "oauth")
Hinweise:
- Auth-Profile-Plan-Ziele erfordern
agentId. - Planeinträge zielen auf
profiles.*.key/profiles.*.tokenund schreiben gleichrangige Refs (keyRef/tokenRef). - Auth-Profile-Refs sind in der Laufzeitauflösung und Audit-Abdeckung enthalten.
- In
openclaw.jsonmüssen SecretRefs strukturierte Objekte wie{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}verwenden. Veraltetesecretref-env:<ENV_VAR>-Marker-Strings werden auf SecretRef-Anmeldedatenpfaden abgelehnt; führen Sieopenclaw doctor --fixaus, um gültige Marker zu migrieren. - OAuth-Richtlinienwächter:
auth.profiles.<id>.mode = "oauth"kann nicht mit SecretRef-Eingaben für dieses Profil kombiniert werden. Start/Neuladen und Auth-Profile-Auflösung schlagen schnell fehl, wenn diese Richtlinie verletzt wird. - Für SecretRef-verwaltete Modell-Provider speichern generierte
agents/*/agent/models.json-Einträge nicht geheime Marker (nicht aufgelöste Geheimniswerte) fürapiKey-/Header-Oberflächen. - Marker-Persistenz ist quellautoritativ: OpenClaw schreibt Marker aus dem aktiven Quellkonfigurations-Snapshot (vor der Auflösung), nicht aus aufgelösten Laufzeit-Geheimniswerten.
- Für Websuche:
- Im expliziten Provider-Modus (
tools.web.search.providergesetzt) ist nur der ausgewählte Provider-Schlüssel aktiv. - Im Auto-Modus (
tools.web.search.providernicht gesetzt) ist nur der erste Provider-Schlüssel aktiv, der gemäß Vorrang aufgelöst wird. - Im Auto-Modus werden nicht ausgewählte Provider-Refs als inaktiv behandelt, bis sie ausgewählt werden.
- Veraltete
tools.web.search.*-Provider-Pfade werden während des Kompatibilitätsfensters weiterhin aufgelöst, aber die kanonische SecretRef-Oberfläche istplugins.entries.<plugin>.config.webSearch.*.
- Im expliziten Provider-Modus (
Nicht unterstützte Anmeldedaten
Nicht im Geltungsbereich enthaltene Anmeldedaten umfassen:
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Begründung:
- Diese Anmeldedaten sind ausgestellte, rotierte, sitzungstragende oder OAuth-dauerhafte Klassen, die nicht zur schreibgeschützten externen SecretRef-Auflösung passen.