API Referenceauth-providers

Connect Or Update Auth Provider

Create or update an auth provider connection.

If a connection for this auth provider already exists for the organization, it will be updated with the new credentials and fields. If no connection exists, a new one will be created.

Args:

db: The database session ctx: The current authentication context auth_provider_connection_in: The auth provider connection data

Returns:

schemas.AuthProviderConnection: The created or updated connection

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
namestringRequired>=1 character<=255 characters

Human-readable name for this auth provider connection

short_namestringRequired
Technical identifier of the auth provider
readable_idstring or nullOptionalformat: "^[a-z0-9]+(-[a-z0-9]+)*$"

URL-safe unique identifier for the connection. Must contain only lowercase letters, numbers, and hyphens. If not provided, it will be automatically generated from the connection name with a random suffix for uniqueness (e.g., ‘composio-connection-ab123’).

descriptionstring or nullOptional
Optional detailed description of what this auth provider connection provides.
auth_fieldsobject or nullOptional
Authentication credentials required to access the auth provider. The required fields vary by auth provider type.

Response

Successful Response
idstringformat: "uuid"
namestring
readable_idstring

URL-safe unique identifier that can be used to reference this connection when setting up source connections.

short_namestring
created_atstringformat: "date-time"
modified_atstringformat: "date-time"
descriptionstring or null
Description of the connection
created_by_emailstring or null
Email of the user who created this connection
modified_by_emailstring or null
Email of the user who last modified this connection

Errors