Skip to main content

Usage

Access this class through the composio.authConfigs property:

Methods

create()

Create a new auth config
Parameters Returns Promise<CreateAuthConfigResponse> — Created auth config Example

delete()

Deletes an authentication configuration. This method permanently removes an auth config from the Composio platform. This action cannot be undone and will prevent any connected accounts that use this auth config from functioning.
Parameters Returns Promise<AuthConfigDeleteResponse> — The deletion response Example

disable()

Disables an authentication configuration. This is a convenience method that calls updateStatus with ‘DISABLED’. When disabled, the auth config cannot be used to create new connected accounts or authenticate with third-party services, but existing connections may continue to work.
Parameters Returns Promise<AuthConfigUpdateStatusResponse> — The updated auth config details Example

enable()

Enables an authentication configuration. This is a convenience method that calls updateStatus with ‘ENABLED’. When enabled, the auth config can be used to create new connected accounts and authenticate with third-party services.
Parameters Returns Promise<AuthConfigUpdateStatusResponse> — The updated auth config details Example

get()

Retrieves a specific authentication configuration by its ID. This method fetches detailed information about a single auth config and transforms the response to the SDK’s standardized format.
Parameters Returns Promise<AuthConfigRetrieveResponse> — The auth config details Example

list()

Lists authentication configurations based on provided filter criteria. This method retrieves auth configs from the Composio API, transforms them to the SDK format, and supports filtering by various parameters.
Parameters Returns Promise<AuthConfigListResponse> — A paginated list of auth configurations Example

update()

Updates an existing authentication configuration. This method allows you to modify properties of an auth config such as credentials, scopes, or tool restrictions. The update type (custom or default) determines which fields can be updated.
Parameters Returns Promise<AuthConfigUpdateResponse> — The updated auth config Example

updateStatus()

Updates the status of an authentication configuration. This method allows you to enable or disable an auth config. When disabled, the auth config cannot be used to create new connected accounts or authenticate with third-party services.
Parameters Returns Promise<AuthConfigUpdateStatusResponse> — The updated auth config details Example