Update a consent policy.

PUT

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

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/consent-policies/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "description": "example", "is_active": true }'

Updates consent policy metadata and activation state.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Consent policy identifier.

Request Body ^required

Media type application/json

object

display_name

string

description

string

is_active

boolean

Example ^generated

{
  "display_name": "example",
  "description": "example",
  "is_active": true
}

Responses

200

Updated consent policy detail.

Media type application/json

object

policy

required

object

items

required

Array<object>

object

Example ^generated

{
  "policy": {},
  "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"
}