Update OAuth configuration value

PUT

/api/admin/settings/oauth-config/{name}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/oauth-config/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "value": true }'

Updates one OAuth configuration value in AUTHRIM_CONFIG. The value type and range are validated from config metadata.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

name

required

string

OAuth configuration name.

Request Body ^required

Media type application/json

object

value

required

key

additional properties

Example

{
  "value": true
}

Responses

200

OAuth config value updated.

Media type application/json

object

success

boolean

config

string

value

note

string

key

additional properties

Example

{
  "success": true,
  "config": "require_pkce",
  "value": true,
  "note": "Config updated. Cache will refresh within 10 seconds."
}

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

404

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