stages_captcha_retrieve
GET/stages/captcha/:stage_uuid/
CaptchaStage Viewset
Request
Path Parameters
A UUID string identifying this Captcha Stage.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
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
]
Public key, acquired your captcha Provider.
When enabled and the received captcha score is outside of the given threshold, the stage will show an error message. When not enabled, the flow will continue, but the data from the captcha will be available in the context for policy decisions
{
"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"
}
],
"public_key": "string",
"js_url": "string",
"api_url": "string",
"score_min_threshold": 0,
"score_max_threshold": 0,
"error_on_invalid_score": true
}
- 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"
}