Update error ID mode setting

PUT

/api/admin/settings/error-id-mode

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/error-id-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "security_only" }'

Stores the error ID generation mode override in AUTHRIM_CONFIG KV.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

mode

required

string

Allowed values: all 5xx security_only none

key

additional properties

Example

{
  "mode": "security_only"
}

Responses

200

Error ID mode updated or reset.

Media type application/json

object

success

boolean

error_id_mode

string

Allowed values: all 5xx security_only none

kv_key

string

note

string

key

additional properties

Example

{
  "success": true,
  "error_id_mode": "security_only",
  "kv_key": "error_id_mode",
  "note": "Only security-tracked errors will include error_id."
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}