@devries-cameron20 / composio Mirror · read-only / commits / a098b1fee
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 22, 09:30 UTC

docs: add credential masking section to connected accounts page

Adds a dedicated section explaining how credential masking works, what fields are affected, and how to disable it via dashboard or API. Replaces the previous brief callout with a comprehensive section. Closes SUP-305 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmithamallesh committed Feb 11, 2026 at 14:03 UTC a098b1fee54a0f9c6b17615a56d6775879207948
1 file changed +36 -6
docs/content/docs/auth-configuration/connected-accounts.mdx
+36 -6
@@ -110,12 +110,6 @@ if (account.state) {
110 </Tab>
111 </Tabs>
112
113 -<Callout type="warn">
114 -If credentials return as `REDACTED` instead of actual values, the **Mask Connected Account Secrets** setting is enabled on your account. This setting redacts all sensitive credential data (tokens, secrets, API keys) for security purposes.
115 -
116 -To view actual credentials, navigate to **Settings → Project Settings → Project Configuration** and disable "Mask Connected Account Secrets".
117 -</Callout>
118 -
113 ## Refresh credentials
114
115 Manually refresh credentials for a connected account:
@@ -220,6 +214,42 @@ console.log('Account deleted successfully');
214 Deletion is permanent. Users must re-authenticate to reconnect.
215 </Callout>
216
217 +## Credential masking
218 +
219 +By default, sensitive fields in connected account responses are partially masked for security. This affects fields like `access_token`, `refresh_token`, `api_key`, `bearer_token`, `password`, and other secrets.
220 +
221 +Instead of returning full values, the API returns the first 4 characters followed by `...`:
222 +
223 +```json
224 +{
225 + "access_token": "gho_...",
226 + "refresh_token": "ghr_...",
227 + "api_key": "sk-l..."
228 +}
229 +```
230 +
231 +Values shorter than 4 characters are replaced with `REDACTED`.
232 +
233 +This applies to the [Get Connected Account](/rest-api/connected-accounts/get-connected-accounts-by-nanoid) and [List Connected Accounts](/rest-api/connected-accounts/get-connected-accounts) endpoints.
234 +
235 +### Disabling masking
236 +
237 +If you need full credential values (e.g., to use tokens in your own API calls), disable masking via either:
238 +
239 +1. **Dashboard**: Go to **Settings → Project Settings → Project Configuration** and turn off "Mask Connected Account Secrets"
240 +2. **API**: Use the [Patch Project Config](/rest-api/projects/patch-org-project-config) endpoint:
241 +
242 +```bash
243 +curl -X PATCH https://backend.composio.dev/api/v3/org/project/config \
244 + -H "x-api-key: YOUR_API_KEY" \
245 + -H "Content-Type: application/json" \
246 + -d '{"mask_secret_keys_in_connected_account": false}'
247 +```
248 +
249 +<Callout type="warn">
250 +Disabling masking exposes full credentials in API responses. Only disable this if your application needs direct access to tokens and you have appropriate security measures in place.
251 +</Callout>
252 +
253 ## Multiple accounts
254
255 Users can connect multiple accounts for the same toolkit (e.g., personal and work Gmail).