Sign in
Auth Configs

Delete an authentication configuration

Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone. Pass ?revoke_on_delete=true to also revoke the upstream credentials of every connection using this auth config via a background job.

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

Path parameters

nanoidstring authConfigId required

The unique identifier of the authentication configuration to delete

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.

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

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

Changed in 3 of the 61 revisions of this API.5

  • b61c29327d741See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 589a7d115a5e3See the full diff
    • ○

      the endpoint scheme security CookieAuth was removed from the API

      api-security-removed

    • ○

      added the new optional query request parameter revoke_on_delete

      new-optional-request-parameter

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 52c71f747c651See the full diff
    • ○

      endpoint added

      endpoint-added