Skip to main content
PATCH
Update an authentication configuration

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Path Parameters

nanoid
string<authConfigId>
required

The unique identifier of the authentication configuration to update

Body

application/json
type
enum<string>
required
Available options:
custom
name
string

The display name of the authentication configuration

Required string length: 1 - 255
credentials
object
sealed_credentials
object

[EXPERIMENTAL] Client-sealed secret fields to redeem through the organization keyring instance (GET /api/v3.1/keyring/transfer_keys). The plaintext must not also appear in credentials. Rotates the stored client_secret without Composio ever holding it.

proxy_config
object | null
restrict_to_following_tools
string[]
deprecated

List of tool slugs this auth config is restricted to use with. DEPRECATED: use Get required scopes to resolve the scopes for the tools you need, then pass those scopes in credentials.scopes.

tool_access_config
object
deprecated

DEPRECATED: use Get required scopes to resolve the scopes for the tools you need, then pass those scopes in credentials.scopes.

shared_credentials
object
deprecated

Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged. DEPRECATED: use shared_connection_fields instead. It takes the same value and behaves the same way.

shared_connection_fields
object

Connection field values inherited by every connected account created under this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged.

is_enabled_for_tool_router
boolean

Whether this auth config is enabled for tool router

Response

Successfully updated auth config

success
boolean
required

Whether the auth config was updated

message
string
required

A human-readable result message