@devries-cameron20 / composio Mirror · read-only / commits / 2719497db
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, 04:30 UTC

docs: add auth config migration guidance to both white-labeling pages

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmitha Mallesh committed Mar 4, 2026 at 02:19 UTC 2719497dbc67951821e9165d55e09c695bda72a7
2 files changed +47
docs/content/docs/auth-configuration/white-labeling.mdx
+8
@@ -127,6 +127,14 @@ For toolkits you haven't white-labeled, use the auth config ID from **Authentica
127
128 For development and testing, Composio's managed auth works fine. No OAuth app setup required.
129
130 +### Switching from Composio-managed to your own OAuth app
131 +
132 +Existing connected accounts are permanently tied to the auth config they were created with. Switching to a custom auth config does not affect them.
133 +
134 +- Existing connections keep working. Tokens continue refreshing using the original auth config's credentials.
135 +- New connections use your custom auth config. Users who connect after the switch will see your app name on the consent screen.
136 +- To fully migrate a user, delete their old connected account and have them re-authenticate through your OAuth app.
137 +
138 ## Sending users directly to the OAuth provider
139
140 By default, when you initiate a connection, Composio returns a shortened redirect URL (`backend.composio.dev/api/v3/s/...`). The user's browser hits this URL first, then gets redirected to the OAuth provider. This means `backend.composio.dev` briefly appears in the browser.
docs/content/docs/white-labeling-authentication.mdx
+39
@@ -120,6 +120,45 @@ Now when users connect GitHub or Slack, they'll see your app name on the consent
120
121 For development and testing, Composio's managed auth works fine. No OAuth app setup required.
122
123 +### Switching from Composio-managed to your own OAuth app
124 +
125 +Existing connected accounts are permanently tied to the auth config they were created with. Switching to a custom auth config does not affect them. You have two options:
126 +
127 +**Keep existing users as-is.** Just pass `authConfigs` for the toolkits you want to white-label. Users who already have a connection keep using it. Users who need to connect for the first time go through your OAuth app:
128 +
129 +<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
130 +<Tab value="Python">
131 +```python
132 +session = composio.create(
133 + user_id="user_123",
134 + auth_configs={
135 + "github": "ac_your_github_config", # new connections use your OAuth app
136 + },
137 +)
138 +# Existing GitHub connections for this user keep working as before.
139 +# Only new connections go through your custom OAuth app.
140 +```
141 +</Tab>
142 +<Tab value="TypeScript">
143 +```typescript
144 +import { Composio } from '@composio/core';
145 +const composio = new Composio({ apiKey: 'your_api_key' });
146 +// ---cut---
147 +const session = await composio.create("user_123", {
148 + authConfigs: {
149 + github: "ac_your_github_config", // new connections use your OAuth app
150 + },
151 +});
152 +// Existing GitHub connections for this user keep working as before.
153 +// Only new connections go through your custom OAuth app.
154 +```
155 +</Tab>
156 +</Tabs>
157 +
158 +Existing users' connections continue using Composio's OAuth client credentials for token refresh until they re-authenticate. Composio does not see or store the user's data.
159 +
160 +**Fully migrate all users.** To move every user to your OAuth app, delete their old connected accounts and have them re-authenticate. There is no way to move an existing connection from one auth config to another without re-authentication.
161 +
162 ## Routing the callback through your domain
163
164 During OAuth, the browser briefly redirects through `backend.composio.dev` so Composio can capture the auth token. Some toolkits also display this URL on the consent screen.