Skip to content
Authrim

Get combined error handling settings

GET
/api/admin/settings/error-config
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/settings/error-config \
  --header 'Authorization: Bearer <token>'

Returns locale, response format, and error ID mode settings with their sources and valid values.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Combined error handling configuration.

Media type application/json
object
locale

Locale setting state.

object
key
additional properties
response_format

Error response format setting state.

object
key
additional properties
error_id_mode

Error ID mode setting state.

object
key
additional properties
cache_ttl_seconds
integer
note
string
key
additional properties
Example 
{
  "locale": {
    "current": "en",
    "source": "default",
    "default": "en",
    "valid_values": [
      "en",
      "ja"
    ],
    "kv_key": "error_locale"
  },
  "response_format": {
    "current": "oauth",
    "source": "default",
    "default": "oauth",
    "valid_values": [
      "oauth",
      "problem_details"
    ],
    "kv_key": "error_response_format",
    "note": "OIDC core endpoints (/authorize, /token, /userinfo, etc.) always use OAuth format regardless of this setting"
  },
  "error_id_mode": {
    "current": "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",
      "5xx": "Generate error_id only for 5xx errors (default)",
      "security_only": "Generate error_id only for security-tracked errors",
      "none": "Never generate error_id"
    }
  },
  "cache_ttl_seconds": 10,
  "note": "Changes take effect within 10 seconds (cache TTL)"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}