Technical reference
SecretRef 자격 증명 서피스
이 페이지는 정식 SecretRef 자격 증명 표면을 정의합니다.
범위 의도:
- 범위 내: OpenClaw가 발급하거나 순환하지 않는, 엄격히 사용자가 제공한 자격 증명.
- 범위 밖: 런타임에서 발급되거나 순환되는 자격 증명, OAuth 갱신 자료, 세션과 유사한 아티팩트.
지원되는 자격 증명
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.serviceAccount형제serviceAccountRef를 통해 (호환성 예외)channels.googlechat.accounts.*.serviceAccount형제serviceAccountRef를 통해 (호환성 예외)
auth-profiles.json 대상 (secrets configure + secrets apply + secrets audit)
profiles.*.keyRef(type: "api_key";auth.profiles.<id>.mode = "oauth"일 때 지원되지 않음)profiles.*.tokenRef(type: "token";auth.profiles.<id>.mode = "oauth"일 때 지원되지 않음)
참고:
- 인증 프로필 계획 대상에는
agentId가 필요합니다. - 계획 항목은
profiles.*.key/profiles.*.token을 대상으로 하고 형제 참조(keyRef/tokenRef)를 씁니다. - 인증 프로필 참조는 런타임 해석 및 감사 범위에 포함됩니다.
openclaw.json에서 SecretRef는{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}같은 구조화된 객체를 사용해야 합니다. 레거시secretref-env:<ENV_VAR>마커 문자열은 SecretRef 자격 증명 경로에서 거부됩니다. 유효한 마커를 마이그레이션하려면openclaw doctor --fix를 실행하세요.- OAuth 정책 가드:
auth.profiles.<id>.mode = "oauth"는 해당 프로필의 SecretRef 입력과 함께 사용할 수 없습니다. 이 정책을 위반하면 시작/다시 로드 및 인증 프로필 해석이 빠르게 실패합니다. - SecretRef가 관리하는 모델 제공자의 경우, 생성된
agents/*/agent/models.json항목은apiKey/헤더 표면에 대해 비밀이 아닌 마커(해석된 비밀 값이 아님)를 유지합니다. - 마커 지속성은 소스 권위적입니다. OpenClaw는 해석된 런타임 비밀 값이 아니라 활성 소스 구성 스냅샷(해석 전)의 마커를 씁니다.
- 웹 검색의 경우:
- 명시적 제공자 모드(
tools.web.search.provider설정)에서는 선택한 제공자 키만 활성화됩니다. - 자동 모드(
tools.web.search.provider미설정)에서는 우선순위에 따라 해석되는 첫 번째 제공자 키만 활성화됩니다. - 자동 모드에서 선택되지 않은 제공자 참조는 선택될 때까지 비활성으로 처리됩니다.
- 레거시
tools.web.search.*제공자 경로는 호환성 기간 동안 계속 해석되지만, 정식 SecretRef 표면은plugins.entries.<plugin>.config.webSearch.*입니다.
- 명시적 제공자 모드(
지원되지 않는 자격 증명
범위 밖 자격 증명에는 다음이 포함됩니다.
commands.ownerDisplaySecrethooks.tokenhooks.gmail.pushTokenhooks.mappings[].sessionKeyauth-profiles.oauth.*channels.discord.threadBindings.webhookTokenchannels.discord.accounts.*.threadBindings.webhookTokenchannels.whatsapp.creds.jsonchannels.whatsapp.accounts.*.creds.json
근거:
- 이러한 자격 증명은 발급되었거나, 순환되거나, 세션을 포함하거나, OAuth로 지속되는 유형이므로 읽기 전용 외부 SecretRef 해석에 맞지 않습니다.