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 string
use_global_settings boolean
use_ssl boolean
use_tls boolean
username string

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
pkuuidrequired
namestringrequired
componentstringrequired
Get object type so that we know how to edit the object
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
flow_set object[]
Array [
pkuuidrequired
policybindingmodel_ptr_iduuidrequired
namestringrequired
slugstringrequired
Visible in the URL.
Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
titlestringrequired
Shown as the Title in Flow pages.
designationFlowDesignationEnum (string)required
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]
backgroundstringrequired
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
policy_engine_modePolicyEngineMode (string)
Possible values: [all, any]
compatibility_modeboolean
Enable compatibility mode, increases compatibility with password managers on mobile devices.
export_urlstringrequired
Get export URL for flow
layoutFlowLayoutEnum (string)
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
denied_actionDeniedActionEnum (string)
Configure what should happen when a flow denies access to a user.
Possible values: [message_continue, message, continue]
]
use_global_settingsboolean
When enabled, global Email connection settings will be used and connection settings below will be ignored.
hoststring
portinteger
Possible values: >= -2147483648 and <= 2147483647
usernamestring
use_tlsboolean
use_sslboolean
timeoutinteger
Possible values: >= -2147483648 and <= 2147483647
from_addressemail
Possible values: <= 254 characters
token_expirystring
Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).
subjectstring
templatestring
activate_user_on_successboolean
Activate users upon completion of stage.
]

Example (auto)

{
  "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": "string",
      "subject": "string",
      "template": "string",
      "activate_user_on_success": true
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/stages/email/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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