AuthConfigs
Methods
list()
Lists authentication configurations based on provided filter criteria.
def list(**query: Unpack[auth_config_list_params.AuthConfigListParams]) -> auth_config_list_response.AuthConfigListResponseParameters
| Name | Type |
|---|---|
query? | Unpack[auth_config_list_params.AuthConfigListParams] |
Returns
auth_config_list_response.AuthConfigListResponse
create()
Create a new auth config
def create(toolkit: str, options: auth_config_create_params.AuthConfig) -> auth_config_create_response.AuthConfigParameters
| Name | Type | Description |
|---|---|---|
toolkit | str | The toolkit to create the auth config for. |
options | auth_config_create_params.AuthConfig | The options to create the auth config with. |
Returns
auth_config_create_response.AuthConfig — The created auth config.
get()
Retrieves a specific authentication configuration by its ID
def get(nanoid: str) -> auth_config_retrieve_response.AuthConfigRetrieveResponseParameters
| Name | Type | Description |
|---|---|---|
nanoid | str | The ID of the auth config to retrieve. |
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.
def update(nanoid: str, *, options: auth_config_update_params.AuthConfigUpdateParams) -> auth_config_update_response.AuthConfigUpdateResponseParameters
| Name | Type | Description |
|---|---|---|
nanoid | str | The ID of the auth config to update. |
options | auth_config_update_params.AuthConfigUpdateParams | The options to update the auth config with. |
Returns
auth_config_update_response.AuthConfigUpdateResponse — The update result with success and message fields.
delete()
Deletes an existing authentication configuration.
def delete(nanoid: str) -> auth_config_delete_response.AuthConfigDeleteResponseParameters
| Name | Type | Description |
|---|---|---|
nanoid | str | The ID of the auth config to delete. |
Returns
auth_config_delete_response.AuthConfigDeleteResponse — The deletion result with success and message fields.
enable()
Enables an existing authentication configuration.
def enable(nanoid: str) -> auth_config_update_status_response.AuthConfigUpdateStatus...Parameters
| Name | Type | Description |
|---|---|---|
nanoid | str | The ID of the auth config to enable. |
Returns
auth_config_update_status_response.AuthConfigUpdateStatus... — The status update result with success and message fields.
disable()
Disables an existing authentication configuration.
def disable(nanoid: str) -> auth_config_update_status_response.AuthConfigUpdateStatus...Parameters
| Name | Type | Description |
|---|---|---|
nanoid | str | The ID of the auth config to disable. |
Returns
auth_config_update_status_response.AuthConfigUpdateStatus... — The status update result with success and message fields.