Upsert a tenant consent requirement.

PUT

/api/admin/consent-requirements/{statementId}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/consent-requirements/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_required": true, "min_version": "20260619", "enforcement": "block", "show_deletion_link": true, "deletion_url": "https://example.com/account/delete", "display_order": 10 }'

Creates or replaces the tenant-level consent requirement for a statement. The request controls required/enforcement behavior, minimum version, deletion link behavior, conditional rules, and ordering.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

statementId

required

string

Consent statement identifier.

Request Body ^required

Media type application/json

object

is_required

required

boolean

min_version

string

/^[0-9]{8}$/

enforcement

string

show_deletion_link

boolean

deletion_url

string format: uri

conditional_rules

Array<object>

object

key

additional properties

display_order

integer

key

additional properties

Example

{
  "is_required": true,
  "min_version": "20260619",
  "enforcement": "block",
  "show_deletion_link": true,
  "deletion_url": "https://example.com/account/delete",
  "display_order": 10
}

Responses

200

Tenant consent requirement response.

Media type application/json

object

id

required

string

tenant_id

required

string

statement_id

required

string

is_required

required

integer

Allowed values: 0 1

min_version

string | null

enforcement

required

string

show_deletion_link

integer

Allowed values: 0 1

deletion_url

string | null

conditional_rules_json

string | null

display_order

integer

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

Example

{
  "is_required": 0,
  "show_deletion_link": 0
}

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