stages_authenticator_email_update

PUT 
/api/v3//stages/authenticator/email/:stage_uuid/

AuthenticatorEmailStage Viewset

Request

Path Parameters

stage_uuid uuidrequired

A UUID string identifying this Email Authenticator Setup Stage.

application/json

Bodyrequired

namestringrequired

Possible values: non-empty

flow_set object[]

Array [

namestringrequired

Possible values: non-empty

slugstringrequired

Visible in the URL.

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

titlestringrequired

Shown as the Title in Flow pages.

Possible values: non-empty

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]

policy_engine_modePolicyEngineMode (string)

Possible values: [all, any]

compatibility_modeboolean

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

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]

]

configure_flowuuidnullable

Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

friendly_namestringnullable

Possible values: non-empty

use_global_settingsboolean

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

hoststring

Possible values: non-empty

portinteger

Possible values: >= -2147483648 and <= 2147483647

usernamestring

passwordstring

use_tlsboolean

use_sslboolean

timeoutinteger

Possible values: >= -2147483648 and <= 2147483647

from_addressemail

Possible values: non-empty and <= 254 characters

subjectstring

Possible values: non-empty

token_expirystring

Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

Possible values: non-empty

templatestring

Possible values: non-empty

Responses

200

application/json

Schema

Schema

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]
]
configure_flowuuidnullable
Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.
friendly_namestringnullable
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
passwordstring
use_tlsboolean
use_sslboolean
timeoutinteger
Possible values: >= -2147483648 and <= 2147483647
from_addressemail
Possible values: <= 254 characters
subjectstring
token_expirystring
Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).
templatestring

Example (auto)

{
  "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"
    }
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "friendly_name": "string",
  "use_global_settings": true,
  "host": "string",
  "port": 0,
  "username": "string",
  "password": "string",
  "use_tls": true,
  "use_ssl": true,
  "timeout": 0,
  "from_address": "user@example.com",
  "subject": "string",
  "token_expiry": "string",
  "template": "string"
}

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.Put, "/api/v3/stages/authenticator/email/:stage_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"flow_set\": [\n    {\n      \"name\": \"string\",\n      \"slug\": \"string\",\n      \"title\": \"string\",\n      \"designation\": \"authentication\",\n      \"policy_engine_mode\": \"all\",\n      \"compatibility_mode\": true,\n      \"layout\": \"stacked\",\n      \"denied_action\": \"message_continue\"\n    }\n  ],\n  \"configure_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"friendly_name\": \"string\",\n  \"use_global_settings\": true,\n  \"host\": \"string\",\n  \"port\": 0,\n  \"username\": \"string\",\n  \"password\": \"string\",\n  \"use_tls\": true,\n  \"use_ssl\": true,\n  \"timeout\": 0,\n  \"from_address\": \"user@example.com\",\n  \"subject\": \"string\",\n  \"token_expiry\": \"string\",\n  \"template\": \"string\"\n}", null, "application/json");
request.Content = content;
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

stage_uuid — pathrequired

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"
    }
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "friendly_name": "string",
  "use_global_settings": true,
  "host": "string",
  "port": 0,
  "username": "string",
  "password": "string",
  "use_tls": true,
  "use_ssl": true,
  "timeout": 0,
  "from_address": "user@example.com",
  "subject": "string",
  "token_expiry": "string",
  "template": "string"
}