API ReferenceAuth Configs

Delete an authentication configurationv3.1

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

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.

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

The unique identifier of the authentication configuration to delete

Format: authConfigId

Query Parameters

revoke_on_deletenullable boolean

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.

Default: false

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v3.1/auth_configs/string"
{  "success": true,  "message": "string",  "revoke_job_id": "pj_1a2b3c4d5e6f"}
Edit this page on GitHub