Get error response format setting

GET

/api/admin/settings/error-response-format

Code sample: Shell / cURL

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

Returns the non-OIDC error response format setting. OIDC core endpoints always keep OAuth error format.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Error response format setting.

Media type application/json

object

response_format

string

Allowed values: oauth problem_details

source

string

default

string

valid_values

Array<string>

kv_key

string

oidc_core_endpoints

Array<string>

note

string

key

additional properties

Example

{
  "response_format": "oauth",
  "source": "default",
  "default": "oauth",
  "valid_values": [
    "oauth",
    "problem_details"
  ],
  "kv_key": "error_response_format",
  "oidc_core_endpoints": [
    "/authorize",
    "/token",
    "/userinfo",
    "/introspect",
    "/revoke"
  ],
  "note": "OIDC core endpoints always use OAuth format. This setting affects non-OIDC endpoints only."
}

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