Skip to main content

stages_email_create

POST 
/api/v3//stages/email/

EmailStage Viewset

Request​

Body

required

    name stringrequired

    Possible values: non-empty

    flow_set

    object[]

  • Array [

    • name stringrequired

    Possible values: non-empty

    slug stringrequired

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    Visible in the URL.

    title stringrequired

    Possible values: non-empty

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    layout FlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

  • ]

    • use_global_settings boolean

    When enabled, global Email connection settings will be used and connection settings below will be ignored.

    host string

    Possible values: non-empty

    port integer

    Possible values: >= -2147483648 and <= 2147483647

    username string
    password string
    use_tls boolean
    use_ssl boolean
    timeout integer

    Possible values: >= -2147483648 and <= 2147483647

    from_address email

    Possible values: non-empty and <= 254 characters

    token_expiry integer

    Possible values: >= -2147483648 and <= 2147483647

    Time in minutes the token sent is valid.

    subject string

    Possible values: non-empty

    template string

    Possible values: non-empty

    activate_user_on_success boolean

    Activate users upon completion of stage.

Responses​

Schema

    pk uuidrequired
    name stringrequired
    component stringrequired

    Get object type so that we know how to edit the object

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    background stringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

  • ]

    • use_global_settings boolean

    When enabled, global Email connection settings will be used and connection settings below will be ignored.

    host string
    port integer

    Possible values: >= -2147483648 and <= 2147483647

    username string
    use_tls boolean
    use_ssl boolean
    timeout integer

    Possible values: >= -2147483648 and <= 2147483647

    from_address email

    Possible values: <= 254 characters

    token_expiry integer

    Possible values: >= -2147483648 and <= 2147483647

    Time in minutes the token sent is valid.

    subject string
    template string
    activate_user_on_success boolean

    Activate users upon completion of stage.

curl -L -X POST '/api/v3/stages/email/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "flow_set": [
    {
      "name": "string",
      "slug": "string",
      "title": "string",
      "designation": "authentication",
      "policy_engine_mode": "all",
      "compatibility_mode": true,
      "layout": "stacked",
      "denied_action": "message_continue"
    }
  ],
  "use_global_settings": true,
  "host": "string",
  "port": 0,
  "username": "string",
  "password": "string",
  "use_tls": true,
  "use_ssl": true,
  "timeout": 0,
  "from_address": "[email protected]",
  "token_expiry": 0,
  "subject": "string",
  "template": "string",
  "activate_user_on_success": true
}'
Request Collapse all
Base URL
/api/v3
Auth
Body required
{
  "name": "string",
  "flow_set": [
    {
      "name": "string",
      "slug": "string",
      "title": "string",
      "designation": "authentication",
      "policy_engine_mode": "all",
      "compatibility_mode": true,
      "layout": "stacked",
      "denied_action": "message_continue"
    }
  ],
  "use_global_settings": true,
  "host": "string",
  "port": 0,
  "username": "string",
  "password": "string",
  "use_tls": true,
  "use_ssl": true,
  "timeout": 0,
  "from_address": "[email protected]",
  "token_expiry": 0,
  "subject": "string",
  "template": "string",
  "activate_user_on_success": true
}