Technical reference
Superficie de credenciales SecretRef
Esta página define la superficie canónica de credenciales SecretRef: qué campos de credenciales aceptan una SecretRef (referencia respaldada por env/file/exec) en lugar de un valor secreto sin procesar.
Alcance:
- Incluido en el alcance: estrictamente las credenciales proporcionadas por el usuario que OpenClaw no emite ni rota.
- Fuera del alcance: credenciales emitidas o rotadas durante la ejecución, material de actualización de OAuth y artefactos similares a sesiones.
Las listas siguientes se generan a partir del registro de destinos del código fuente y se comprueban con docs/reference/secretref-user-supplied-credentials-matrix.json en la Pipeline de CI; no edite las entradas manualmente.
Credenciales compatibles
Destinos 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.*.apiKeymemory.search.remote.apiKeyagents.entries.*.tts.providers.*.apiKeyagents.entries.*.memory.search.remote.apiKeytalk.providers.*.apiKeytalk.realtime.providers.*.apiKeytts.providers.*.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.firecrawl.config.webFetch.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.authTokenplugins.entries.webhooks.config.routes.*.secretgateway.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.clickclack.tokenchannels.clickclack.accounts.*.tokenchannels.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.serviceAccountmediante elserviceAccountRefrelacionado (excepción de compatibilidad)channels.googlechat.accounts.*.serviceAccountmediante elserviceAccountRefrelacionado (excepción de compatibilidad)
Destinos 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 se dirigen aprofiles.*.key/profiles.*.tokeny escriben referencias relacionadas (keyRef/tokenRef). Las referencias de perfiles de autenticación se incluyen en la resolución durante la 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 de marcadoressecretref-env:<ENV_VAR>heredadas se rechazan en las rutas de credenciales SecretRef; ejecuteopenclaw doctor --fixpara migrar los marcadores válidos. - Protección de la política de OAuth:
auth.profiles.<id>.mode = "oauth"no puede combinarse con entradas SecretRef para ese perfil. El inicio o la recarga y la resolución del perfil de autenticación fallan de inmediato cuando se infringe esta política. - Para los proveedores de modelos administrados mediante SecretRef, las entradas
agents/*/agent/models.jsongeneradas conservan marcadores no secretos (no valores secretos resueltos) para las superficiesapiKey/de encabezados. La persistencia de marcadores se rige por la fuente: OpenClaw escribe los marcadores a partir de la instantánea de configuración de la fuente activa (antes de la resolución), no a partir de los valores secretos resueltos durante la ejecución. - El arranque en frío del Gateway puede aislar los fallos de resolución reintentables de propietarios asignados que no sean el Gateway. Las clases asignadas actuales incluyen proveedores de modelos y Skills, proveedores de contenido multimedia/TTS/cron, perfiles de autenticación aptos, memoria por agente, SSH del entorno aislado, cuentas de canales y rutas de plugins declaradas en el manifiesto. El arranque conserva las referencias explícitas de cada propietario con errores en la instantánea de ejecución, informa del propietario mediante el estado y doctor, y rechaza las solicitudes destinadas a ese propietario sin probar credenciales de menor precedencia. La recarga y la comprobación previa a la escritura de la configuración usan la misma política basada en propietarios: los propietarios en buen estado se actualizan; un propietario apto con errores permanece obsoleto únicamente cuando las identidades de sus referencias, las definiciones de sus proveedores y el contrato no secreto completo del propietario no han cambiado; un fallo nuevo o modificado pasa a estar en frío. La autenticación de entrada del Gateway, las referencias o los valores estructuralmente no válidos, los propietarios con cierre seguro ante fallos y los propietarios que actualmente no están asignados siguen siendo estrictos.
- Para la búsqueda web: en el modo de proveedor explícito (
tools.web.search.providerestablecido), solo está activa la clave del proveedor seleccionado. En el modo automático (tools.web.search.providerno establecido), solo está activa la primera clave de proveedor que se resuelve según la precedencia, y las referencias de proveedores no seleccionados se consideran inactivas hasta que se seleccionen. Las credenciales del proveedor usanplugins.entries.<plugin>.config.webSearch.*. identity: "user"de Slack usachannels.slack.userTokenconchannels.slack.appTokenpara Socket Mode ochannels.slack.signingSecretpara el modo HTTP. El mismo emparejamiento se aplica enchannels.slack.accounts.*; no se requiere ningún token de bot para esta identidad.
Credenciales no compatibles
Estas credenciales son clases emitidas, rotadas, asociadas a sesiones o persistentes de OAuth que no se ajustan a la resolución externa de solo lectura de SecretRef:
hooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
Contenido relacionado
Was this useful?