Auth Configs

Delete an authentication configuration

Changed on

Deletes an authentication configuration. This operation cannot be undone. Pass ?revoke_on_delete=true to also revoke the upstream credentials of every connection using this auth config.

delete/api/v3.1/auth_configs/{nanoid}

Request

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

Path parameters

nanoidstring authConfigId required

The unique identifier of the authentication configuration to delete

Query parameters

revoke_on_deleteboolean nullable

When true, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a revoke_job_id. Defaults to false. Revocation is irreversible — recovering a deleted entity does not restore working credentials.

Response

Successfully deleted auth config

successboolean required

Whether the auth config was deleted

messagestring required

A human-readable result message

revoke_job_idstring

Identifier of the background revoke job started for this delete. Present only when revoke_on_delete=true. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.

Example response

{
  "revoke_job_id": "pj_1a2b3c4d5e6f"
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id deleteV3_1AuthConfigsByNanoid removed and replaced with deleteAuthConfigsByNanoid

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b61c29327d74Revision changes
    • info

      added the required property to the response with the status