Skip to content

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

Fix: Make OAuth Params optional in creation connected accounts programmatically (#1870)

Musthaq Ahamad05ce9c63ae47
diff --git a/.changeset/whole-papayas-nail.md b/.changeset/whole-papayas-nail.md
new file mode 100644
index 000000000..52f9b33cb
--- /dev/null
+++ b/.changeset/whole-papayas-nail.md
@@ -0,0 +1,5 @@
+---
+'@composio/core': patch
+---
+
+Fix make access token and token type optional in oauth scheme
diff --git a/fern/pages/src/tool-calling/authenticating-tools.mdx b/fern/pages/src/tool-calling/authenticating-tools.mdx
index ee762c6d0..a62557239 100644
--- a/fern/pages/src/tool-calling/authenticating-tools.mdx
+++ b/fern/pages/src/tool-calling/authenticating-tools.mdx
@@ -165,6 +165,35 @@ const connRequest = await composio.connectedAccounts.initiate(
</CodeGroup>
+### Services with Additional Parameters
+
+Some services like Zendesk require additional parameters such as `subdomain`:
+
+<CodeGroup>
+```python
+# For Zendesk - include subdomain
+connection_request = composio.connected_accounts.initiate(
+ user_id=user_id,
+ auth_config_id=auth_config_id,
+ config=auth_scheme.oauth2(subdomain="mycompany") # For mycompany.zendesk.com
+)
+```
+
+```typescript
+import { AuthScheme } from '@composio/core';
+// For Zendesk - include subdomain
+const connRequest = await composio.connectedAccounts.initiate(
+ userId,
+ authConfigId,
+ {
+ config: AuthScheme.OAuth2({
+ subdomain: 'mycompany'
+ })
+ }
+);
+```
+</CodeGroup>
+
### API Key Connections
For API key authentication, you can either *collect API keys from each user* or *use your own API key* for all users. Popular Toolkits that use API Keys include Stripe, Perplexity etc.
diff --git a/ts/docs/api/connected-accounts.md b/ts/docs/api/connected-accounts.md
index a061f11eb..209cb5608 100644
--- a/ts/docs/api/connected-accounts.md
+++ b/ts/docs/api/connected-accounts.md
@@ -41,6 +41,13 @@ const oauthConnection = await composio.connectedAccounts.initiate('user_123', 'a
callbackUrl: 'https://myapp.com/auth/callback',
});
+// For OAuth configs requiring additional parameters (e.g., Zendesk, PostHog)
+const zendeskConnection = await composio.connectedAccounts.initiate('user_123', 'zendesk_auth_config', {
+ config: AuthScheme.OAuth2({
+ subdomain: "yout_subdomain_here"
+ })
+});
+
// For API Key based auth configs (requires additional parameters)
const apiKeyConnection = await composio.connectedAccounts.initiate('user_123', 'auth_config_456', {
config: AuthScheme.ApiKey({
diff --git a/ts/packages/core/src/models/AuthScheme.ts b/ts/packages/core/src/models/AuthScheme.ts
index f93136126..debfa5091 100644
--- a/ts/packages/core/src/models/AuthScheme.ts
+++ b/ts/packages/core/src/models/AuthScheme.ts
@@ -13,8 +13,8 @@ export class AuthScheme {
*/
static OAuth2(
params: BaseConnectionFields & {
- access_token: string;
- token_type: string;
+ access_token?: string;
+ token_type?: string;
id_token?: string;
refresh_token?: string;
expires_in?: number;
@@ -49,7 +49,7 @@ export class AuthScheme {
*/
static OAuth1(
params: BaseConnectionFields & {
- oauth_token: string;
+ oauth_token?: string;
consumer_key?: string;
redirectUrl?: string;
callback_url?: string;
diff --git a/ts/packages/core/src/models/ConnectedAccounts.ts b/ts/packages/core/src/models/ConnectedAccounts.ts
index c53a82c40..7961b98ac 100644
--- a/ts/packages/core/src/models/ConnectedAccounts.ts
+++ b/ts/packages/core/src/models/ConnectedAccounts.ts
@@ -160,7 +160,7 @@ export class ConnectedAccounts {
});
if (connectedAccount.items.length > 0 && !options?.allowMultiple) {
throw new ComposioMultipleConnectedAccountsError(
- `Multiple connected accounts found for user ${userId} in auth config ${authConfigId}`
+ `Multiple connected accounts found for user ${userId} in auth config ${authConfigId}. Please use the allowMultiple option to allow multiple connected accounts.`
);
} else if (connectedAccount.items.length > 0) {
logger.warn(