Get error ID mode setting

GET

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

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/error-id-mode \
  --header 'Authorization: Bearer <token>'

Returns when error_id values are added to error responses, including the security-tracked error list.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Error ID generation mode.

Media type application/json

object

error_id_mode

string

Allowed values: all 5xx security_only none

source

string

default

string

valid_values

Array<string>

kv_key

string

description

Description for each error ID mode.

object

key

additional properties

string

security_tracked_errors

Array<string>

key

additional properties

Example

{
  "error_id_mode": "5xx",
  "source": "default",
  "default": "5xx",
  "valid_values": [
    "all",
    "5xx",
    "security_only",
    "none"
  ],
  "kv_key": "error_id_mode",
  "description": {
    "all": "Generate error_id for all errors - useful for debugging",
    "5xx": "Generate error_id only for server errors (5xx) - default, recommended for production",
    "security_only": "Generate error_id only for security-tracked errors (invalid_client, invalid_grant, etc.)",
    "none": "Never generate error_id - minimal response size"
  },
  "security_tracked_errors": [
    "invalid_client",
    "invalid_grant",
    "unauthorized_client",
    "access_denied"
  ]
}

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"
}