List tenant consent requirements.

GET

/api/admin/consent-requirements

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/consent-requirements \
  --header 'Authorization: Bearer <token>'

Lists tenant-level consent requirements for consent statements, including required/enforcement flags, optional minimum version, deletion link settings, and display order.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Tenant consent requirement list response.

Media type application/json

object

requirements

required

Array<object>

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

key

additional properties

Example

{
  "requirements": [
    {
      "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"
}