Skip to content
Authrim

Upsert a client consent requirement override.

PUT
/api/admin/clients/{clientId}/consent-overrides/{statementId}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/clients/example/consent-overrides/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "requirement": "required", "min_version": "20260619", "enforcement": "block", "display_order": 10 }'

Creates or replaces a consent requirement override for one client and consent statement. The override may change requirement, minimum version, enforcement, conditional rules, and display order.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
clientId
required
string

Client identifier.

statementId
required
string

Consent statement identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
requirement
string
Allowed values: inherit required optional disabled
min_version
string
/^[0-9]{8}$/
enforcement
string
conditional_rules
Array<object>
object
key
additional properties
display_order
integer
key
additional properties
Example 
{
  "requirement": "required",
  "min_version": "20260619",
  "enforcement": "block",
  "display_order": 10
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Client consent override response.

Media type application/json
object
id
required
string
tenant_id
required
string
client_id
required
string
statement_id
required
string
requirement
required
string
min_version
string | null
enforcement
string | null
conditional_rules_json
string | null
display_order
integer | null
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
Example generated
{
  "id": "example",
  "tenant_id": "example",
  "client_id": "example",
  "statement_id": "example",
  "requirement": "example",
  "min_version": "example",
  "enforcement": "example",
  "conditional_rules_json": "example",
  "display_order": 1,
  "created_at": 1,
  "updated_at": 1
}

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