Replace consent policy items.

PUT

/api/admin/consent-policies/{id}/items

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/consent-policies/example/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "items": [ { "statement_id": "example", "requirement": "required", "version_mode": "current", "version_id": "example", "min_version": "example", "checkbox_mode": "none", "checkbox_default_checked": true, "binding_type": "subject", "binding_value": "example", "evidence_profile": "example", "language_fallback": "example", "display_order": 1 } ] }'

Replaces the consent statements that belong to a consent policy.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Consent policy identifier.

Request Body ^required

Media type application/json

object

items

required

Array<object>

object

statement_id

required

string

requirement

required

string

Allowed values: required optional hidden

version_mode

required

string

Allowed values: current fixed minimum

version_id

string

min_version

string

checkbox_mode

required

string

Allowed values: none required optional

checkbox_default_checked

boolean

binding_type

string

Allowed values: subject scope claim saml_attribute destination_field_set

binding_value

string

evidence_profile

string

language_fallback

string

display_order

integer

Responses

200

Replaced consent policy items.

Media type application/json

object

items

required

Array<object>

object

Example ^generated

{
  "items": [
    {}
  ]
}

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