Update error response format setting

PUT

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

Code sample: Shell / cURL

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

Stores the non-OIDC error response format override in AUTHRIM_CONFIG KV.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

format

required

string

Allowed values: oauth problem_details

key

additional properties

Example

{
  "format": "problem_details"
}

Responses

200

Error response format updated or reset.

Media type application/json

object

success

boolean

response_format

string

Allowed values: oauth problem_details

kv_key

string

note

string

key

additional properties

Example

{
  "success": true,
  "response_format": "problem_details",
  "kv_key": "error_response_format",
  "note": "Non-OIDC endpoints will now return RFC 9457 Problem Details format. OIDC core endpoints remain OAuth format."
}

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