stages_email_retrieve
GET/stages/email/:stage_uuid/
EmailStage Viewset
Request
Path Parameters
A UUID string identifying this Email 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
]
When enabled, global Email connection settings will be used and connection settings below will be ignored.
Possible values: >= -2147483648
and <= 2147483647
Possible values: >= -2147483648
and <= 2147483647
Possible values: <= 254 characters
Possible values: >= -2147483648
and <= 2147483647
Time in minutes the token sent is valid.
Activate users upon completion of stage.
{
"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"
}
],
"use_global_settings": true,
"host": "string",
"port": 0,
"username": "string",
"use_tls": true,
"use_ssl": true,
"timeout": 0,
"from_address": "user@example.com",
"token_expiry": 0,
"subject": "string",
"template": "string",
"activate_user_on_success": true
}
- application/json
- Schema
- Example (from schema)
Schema
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}