API ReferenceAuth Configs

Enable or disable an authentication configurationv3.1Legacy

Deprecated

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

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.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

The unique identifier of the authentication configuration to update

Format: authConfigId
statusenumRequired

The new status to set for the auth configuration

Possible values:
ENABLEDDISABLED

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v3.1/auth_configs/string/ENABLED"
{  "success": true,  "message": "string"}