stages_consent_list
GET/stages/consent/
ConsentStage Viewset
Request
Query Parameters
Possible values: [always_require
, expiring
, permanent
]
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
pagination
object
required
results
object[]
required
Get object type so that we know how to edit the object
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
flow_set
object[]
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Visible in the URL.
Shown as the Title in Flow pages.
Possible values: [authentication
, authorization
, invalidation
, enrollment
, unenrollment
, recovery
, stage_configuration
]
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Possible values: [all
, any
]
Enable compatibility mode, increases compatibility with password managers on mobile devices.
Get export URL for flow
Possible values: [stacked
, content_left
, content_right
, sidebar_left
, sidebar_right
]
Possible values: [message_continue
, message
, continue
]
Possible values: [always_require
, permanent
, expiring
]
Offset after which consent expires. (Format: hours=1;minutes=2;seconds=3).
{
"pagination": {
"next": 0,
"previous": 0,
"count": 0,
"current": 0,
"total_pages": 0,
"start_index": 0,
"end_index": 0
},
"results": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"component": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"flow_set": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"title": "string",
"designation": "authentication",
"background": "string",
"policy_engine_mode": "all",
"compatibility_mode": true,
"export_url": "string",
"layout": "stacked",
"denied_action": "message_continue"
}
],
"mode": "always_require",
"consent_expire_in": "string"
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}