Superfície de credenciais SecretRef
Esta página define a superfície canônica de credenciais SecretRef. Intenção do escopo:- No escopo: credenciais estritamente fornecidas pelo usuário que o OpenClaw não emite nem rotaciona.
- Fora do escopo: credenciais emitidas em runtime ou rotativas, material de atualização OAuth e artefatos semelhantes a sessão.
Credenciais compatíveis
Alvos em 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.serviceAccountvia irmãoserviceAccountRef(exceção de compatibilidade)channels.googlechat.accounts.*.serviceAccountvia irmãoserviceAccountRef(exceção de compatibilidade)
Alvos em auth-profiles.json (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key"; não compatível quandoauth.profiles.<id>.mode = "oauth")profiles.*.tokenRef(type: "token"; não compatível quandoauth.profiles.<id>.mode = "oauth")
- Alvos de plano de perfil de autenticação exigem
agentId. - Entradas de plano têm como alvo
profiles.*.key/profiles.*.tokene gravam refs irmãs (keyRef/tokenRef). - Refs de perfil de autenticação são incluídas na resolução em runtime e na cobertura de auditoria.
- Proteção de política OAuth:
auth.profiles.<id>.mode = "oauth"não pode ser combinado com entradas SecretRef para esse perfil. Inicialização/recarregamento e resolução de perfil de autenticação falham rapidamente quando essa política é violada. - Para provedores de modelo gerenciados por SecretRef, entradas geradas em
agents/*/agent/models.jsonpersistem marcadores não secretos (não valores de segredo resolvidos) para superfíciesapiKey/header. - A persistência de marcadores é autoritativa à origem: o OpenClaw grava marcadores a partir do snapshot de configuração de origem ativo (pré-resolução), não a partir de valores de segredo resolvidos em runtime.
- Para busca na web:
- No modo de provedor explícito (
tools.web.search.providerdefinido), apenas a chave do provedor selecionado fica ativa. - No modo automático (
tools.web.search.providernão definido), apenas a primeira chave de provedor que é resolvida por precedência fica ativa. - No modo automático, refs de provedores não selecionados são tratadas como inativas até serem selecionadas.
- Caminhos legados de provedor
tools.web.search.*ainda são resolvidos durante a janela de compatibilidade, mas a superfície canônica de SecretRef éplugins.entries.<plugin>.config.webSearch.*.
- No modo de provedor explícito (
Credenciais não compatíveis
Credenciais fora do escopo incluem:commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
- Essas credenciais são emitidas, rotacionadas, carregam sessão ou pertencem a classes duráveis de OAuth que não se encaixam na resolução externa SecretRef somente leitura.