API ReferenceAuth Configs

Enable or disable an authentication configurationv3.1

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

Updates the status of an authentication configuration to either enabled or disabled. Disabled configurations 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"}