stages_email_list

GET 
/api/v3//stages/email/

EmailStage Viewset

Request

Query Parameters

activate_user_on_success boolean
from_address string
host string
name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

port integer
search string

A search term.

subject string
template string
timeout integer
token_expiry integer
use_global_settings boolean
use_ssl boolean
use_tls boolean
username string

Responses

200

application/json

Schema

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

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.

]

Example (from schema)

{
  "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"
        }
      ],
      "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
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/stages/email/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

activate_user_on_success — query

---truefalse

from_address — query

host — query

name — query

ordering — query

page — query

page_size — query

port — query

search — query

subject — query

template — query

timeout — query

token_expiry — query

use_global_settings — query

---truefalse

use_ssl — query

---truefalse

use_tls — query

---truefalse

username — query