API ReferenceAuth Configs

Update an authentication configuration

Markdown
PATCH
/api/v3/auth_configs/{nanoid}

Modifies an existing authentication configuration with new credentials or other settings. Only specified fields will be updated.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

nanoid*string

The unique identifier of the authentication configuration to update

FormatauthConfigId

Request Body

application/json

type*string
Value in"custom"
credentials?
proxy_config?|null
restrict_to_following_tools?array<string>Deprecated

Use tool_access_config instead. This field will be deprecated in the future.

tool_access_config?
shared_credentials?

Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config.

is_enabled_for_tool_router?boolean

Whether this auth config is enabled for tool router

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://backend.composio.dev/api/v3/auth_configs/string" \  -H "Content-Type: application/json" \  -d '{    "auth_config": {      "credentials": {        "api_key": "YOUR_NEW_API_KEY",        "client_secret": "YOUR_NEW_CLIENT_SECRET"      },      "restrict_to_following_tools": [        "tool1",        "tool2"      ]    }  }'
{}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}