Technical reference
Superficie de credenciales de SecretRef
Esta página define la superficie canónica de credenciales SecretRef.
Intención del alcance:
- Dentro del alcance: credenciales estrictamente proporcionadas por el usuario que OpenClaw no emite ni rota.
- Fuera del alcance: credenciales emitidas en tiempo de ejecución o rotativas, material de actualización de OAuth y artefactos similares a sesiones.
Credenciales compatibles
Destinos de 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.*.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.serviceAccountmediante el campo hermanoserviceAccountRef(excepción de compatibilidad)channels.googlechat.accounts.*.serviceAccountmediante el campo hermanoserviceAccountRef(excepción de compatibilidad)
Destinos de auth-profiles.json (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; no compatible cuandoauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; no compatible cuandoauth.profiles.<id>.mode = "oauth")
Notas:
- Los destinos del plan de perfiles de autenticación requieren
agentId. - Las entradas del plan apuntan a
profiles.*.key/profiles.*.tokeny escriben referencias hermanas (keyRef/tokenRef). - Las referencias de perfiles de autenticación se incluyen en la resolución en tiempo de ejecución y en la cobertura de auditoría.
- En
openclaw.json, las SecretRefs deben usar objetos estructurados como{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}. Las cadenas marcadoras heredadassecretref-env:<ENV_VAR>se rechazan en rutas de credenciales SecretRef; ejecutaopenclaw doctor --fixpara migrar marcadores válidos. - Protección de política de OAuth:
auth.profiles.<id>.mode = "oauth"no se puede combinar con entradas SecretRef para ese perfil. El inicio/recarga y la resolución de perfiles de autenticación fallan rápido cuando se infringe esta política. - Para proveedores de modelos gestionados por SecretRef, las entradas generadas de
agents/*/agent/models.jsonconservan marcadores no secretos (no valores secretos resueltos) para las superficies deapiKey/encabezados. - La persistencia de marcadores está determinada por la fuente: OpenClaw escribe marcadores desde la instantánea activa de configuración de origen (antes de la resolución), no desde valores secretos resueltos en tiempo de ejecución.
- Para la búsqueda web:
- En modo de proveedor explícito (
tools.web.search.providerdefinido), solo está activa la clave del proveedor seleccionado. - En modo automático (
tools.web.search.providersin definir), solo está activa la primera clave de proveedor que se resuelve por precedencia. - En modo automático, las referencias de proveedores no seleccionados se tratan como inactivas hasta que se seleccionan.
- Las rutas de proveedores heredadas
tools.web.search.*aún se resuelven durante la ventana de compatibilidad, pero la superficie canónica de SecretRef esplugins.entries.<plugin>.config.webSearch.*.
- En modo de proveedor explícito (
Credenciales no compatibles
Las credenciales fuera del alcance incluyen:
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Justificación:
- Estas credenciales son clases emitidas, rotadas, portadoras de sesión o duraderas de OAuth que no encajan con la resolución externa de SecretRef de solo lectura.