AuthConfigs - Composio

Methods

list()

Lists authentication configurations based on provided filter criteria.

python

def list(query: auth_config_list_params.AuthConfigListParams = ...) -> auth_config_list_response.AuthConfigListResponse

Parameters

Name	Type
`query?`	`auth_config_list_params.AuthConfigListParams`

Returns

auth_config_list_response.AuthConfigListResponse

create()

Create a new auth config

python

def create(toolkit: str, options: auth_config_create_params.AuthConfig) -> auth_config_create_response.AuthConfig

Parameters

Name	Type
`toolkit`	`str`
`options`	`auth_config_create_params.AuthConfig`

Returns

auth_config_create_response.AuthConfig — The created auth config.

get()

Retrieves a specific authentication configuration by its ID

python

def get(nanoid: str) -> auth_config_retrieve_response.AuthConfigRetrieveResponse

Parameters

Name	Type
`nanoid`	`str`

Returns

auth_config_retrieve_response.AuthConfigRetrieveResponse — The retrieved auth config.

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.

python

def update(nanoid: str, options: auth_config_update_params.AuthConfigUpdateParams) -> Dict

Parameters

Name	Type
`nanoid`	`str`
`options`	`auth_config_update_params.AuthConfigUpdateParams`

Returns

Dict — The updated auth config.

delete()

Deletes an existing authentication configuration.

python

def delete(nanoid: str) -> Dict

Parameters

Name	Type
`nanoid`	`str`

Returns

Dict — The deleted auth config.

enable()

Enables an existing authentication configuration.

python

def enable(nanoid: str) -> Dict

Parameters

Name	Type
`nanoid`	`str`

Returns

Dict — The enabled auth config.

disable()

Disables an existing authentication configuration.

python

def disable(nanoid: str) -> Dict

Parameters

Name	Type
`nanoid`	`str`

Returns

Dict — The disabled auth config.

View source