Auth Configs

Enable or disable an authentication configuration (DEPRECATED)

Changed on

DEPRECATED: We are controlling the API surface and the dependencies between endpoints, and enabling or disabling an auth config is covered by existing endpoints. To stop new connections through an auth config, stop creating connected accounts with it; to remove it, delete it with DELETE /api/v3/auth_configs/{nanoid} (pass ?revoke_on_delete=true to also revoke the upstream credentials of its connections). This endpoint still works for existing integrations but may be removed in a future release. It sets the auth config to ENABLED or DISABLED; disabled auth configs cannot be used for new connections.

patch/api/v3.1/auth_configs/{nanoid}/{status}

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/auth_configs/{nanoid}/{status}
  • Auth
    API key in header x-api-key

Path parameters

nanoidstring authConfigId required

The unique identifier of the authentication configuration to update

status'ENABLED' | 'DISABLED' required

The new status to set for the auth configuration

Response

Successfully updated auth config status

successboolean required

Whether the status update succeeded

messagestring required

A human-readable result message

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id patchV3_1AuthConfigsByNanoidByStatus removed and replaced with patchAuthConfigsByNanoidByStatus

    • info

      endpoint deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API