@quantumclaw/quantumclaw 2026.3.22

package/docs/reference/secretref-user-supplied-credentials-matrix.json

@@ -0,0 +1,563 @@
+{
+  "version": 1,
+  "matrixId": "strictly-user-supplied-credentials",
+  "pathSyntax": "Dot path with \"*\" for map keys and \"[]\" for arrays.",
+  "scope": "Credentials that are strictly user-supplied and not minted/rotated by QuantumClaw runtime.",
+  "excludedMutableOrRuntimeManaged": [
+    "commands.ownerDisplaySecret",
+    "channels.matrix.accessToken",
+    "channels.matrix.accounts.*.accessToken",
+    "hooks.token",
+    "hooks.gmail.pushToken",
+    "hooks.mappings[].sessionKey",
+    "auth-profiles.oauth.*",
+    "discord.threadBindings.*.webhookToken",
+    "whatsapp.creds.json"
+  ],
+  "entries": [
+    {
+      "id": "agents.defaults.memorySearch.remote.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "agents.defaults.memorySearch.remote.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "agents.list[].memorySearch.remote.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "agents.list[].memorySearch.remote.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "auth-profiles.api_key.key",
+      "configFile": "auth-profiles.json",
+      "path": "profiles.*.key",
+      "refPath": "profiles.*.keyRef",
+      "when": {
+        "type": "api_key"
+      },
+      "secretShape": "sibling_ref",
+      "optIn": true
+    },
+    {
+      "id": "auth-profiles.token.token",
+      "configFile": "auth-profiles.json",
+      "path": "profiles.*.token",
+      "refPath": "profiles.*.tokenRef",
+      "when": {
+        "type": "token"
+      },
+      "secretShape": "sibling_ref",
+      "optIn": true
+    },
+    {
+      "id": "channels.bluebubbles.accounts.*.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.bluebubbles.accounts.*.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.bluebubbles.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.bluebubbles.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.accounts.*.pluralkit.token",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.accounts.*.pluralkit.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.accounts.*.token",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.accounts.*.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.accounts.*.voice.tts.elevenlabs.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.accounts.*.voice.tts.elevenlabs.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.accounts.*.voice.tts.openai.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.accounts.*.voice.tts.openai.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.pluralkit.token",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.pluralkit.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.token",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.voice.tts.elevenlabs.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.voice.tts.elevenlabs.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.discord.voice.tts.openai.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.discord.voice.tts.openai.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.accounts.*.appSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.accounts.*.appSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.accounts.*.encryptKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.accounts.*.encryptKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.accounts.*.verificationToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.accounts.*.verificationToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.appSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.appSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.encryptKey",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.encryptKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.feishu.verificationToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.feishu.verificationToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.googlechat.accounts.*.serviceAccount",
+      "configFile": "quantumclaw.json",
+      "path": "channels.googlechat.accounts.*.serviceAccount",
+      "refPath": "channels.googlechat.accounts.*.serviceAccountRef",
+      "secretShape": "sibling_ref",
+      "optIn": true,
+      "notes": "Google Chat compatibility exception: sibling ref field remains canonical."
+    },
+    {
+      "id": "channels.googlechat.serviceAccount",
+      "configFile": "quantumclaw.json",
+      "path": "channels.googlechat.serviceAccount",
+      "refPath": "channels.googlechat.serviceAccountRef",
+      "secretShape": "sibling_ref",
+      "optIn": true,
+      "notes": "Google Chat compatibility exception: sibling ref field remains canonical."
+    },
+    {
+      "id": "channels.irc.accounts.*.nickserv.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.irc.accounts.*.nickserv.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.irc.accounts.*.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.irc.accounts.*.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.irc.nickserv.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.irc.nickserv.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.irc.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.irc.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.matrix.accounts.*.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.matrix.accounts.*.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.matrix.password",
+      "configFile": "quantumclaw.json",
+      "path": "channels.matrix.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.mattermost.accounts.*.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.mattermost.accounts.*.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.mattermost.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.mattermost.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.msteams.appPassword",
+      "configFile": "quantumclaw.json",
+      "path": "channels.msteams.appPassword",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.nextcloud-talk.accounts.*.apiPassword",
+      "configFile": "quantumclaw.json",
+      "path": "channels.nextcloud-talk.accounts.*.apiPassword",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.nextcloud-talk.accounts.*.botSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.nextcloud-talk.accounts.*.botSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.nextcloud-talk.apiPassword",
+      "configFile": "quantumclaw.json",
+      "path": "channels.nextcloud-talk.apiPassword",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.nextcloud-talk.botSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.nextcloud-talk.botSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.accounts.*.appToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.accounts.*.appToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.accounts.*.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.accounts.*.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.accounts.*.signingSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.accounts.*.signingSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.accounts.*.userToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.accounts.*.userToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.appToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.appToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.signingSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.signingSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.slack.userToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.slack.userToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.telegram.accounts.*.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.telegram.accounts.*.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.telegram.accounts.*.webhookSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.telegram.accounts.*.webhookSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.telegram.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.telegram.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.telegram.webhookSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.telegram.webhookSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.zalo.accounts.*.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.zalo.accounts.*.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.zalo.accounts.*.webhookSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.zalo.accounts.*.webhookSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.zalo.botToken",
+      "configFile": "quantumclaw.json",
+      "path": "channels.zalo.botToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "channels.zalo.webhookSecret",
+      "configFile": "quantumclaw.json",
+      "path": "channels.zalo.webhookSecret",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "cron.webhookToken",
+      "configFile": "quantumclaw.json",
+      "path": "cron.webhookToken",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "gateway.auth.password",
+      "configFile": "quantumclaw.json",
+      "path": "gateway.auth.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "gateway.auth.token",
+      "configFile": "quantumclaw.json",
+      "path": "gateway.auth.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "gateway.remote.password",
+      "configFile": "quantumclaw.json",
+      "path": "gateway.remote.password",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "gateway.remote.token",
+      "configFile": "quantumclaw.json",
+      "path": "gateway.remote.token",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "messages.tts.elevenlabs.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "messages.tts.elevenlabs.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "messages.tts.openai.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "messages.tts.openai.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "models.providers.*.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "models.providers.*.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "models.providers.*.headers.*",
+      "configFile": "quantumclaw.json",
+      "path": "models.providers.*.headers.*",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.brave.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.brave.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.firecrawl.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.firecrawl.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.google.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.google.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.moonshot.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.moonshot.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.perplexity.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.perplexity.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.tavily.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.tavily.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "plugins.entries.xai.config.webSearch.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "plugins.entries.xai.config.webSearch.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "skills.entries.*.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "skills.entries.*.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "talk.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "talk.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "talk.providers.*.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "talk.providers.*.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.fetch.firecrawl.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.fetch.firecrawl.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.search.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.search.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.search.gemini.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.search.gemini.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.search.grok.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.search.grok.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.search.kimi.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.search.kimi.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    },
+    {
+      "id": "tools.web.search.perplexity.apiKey",
+      "configFile": "quantumclaw.json",
+      "path": "tools.web.search.perplexity.apiKey",
+      "secretShape": "secret_input",
+      "optIn": true
+    }
+  ]
+}