stages_prompt_prompts_create

POST 
/api/v3//stages/prompt/prompts/

Prompt Viewset

Request

application/json

Bodyrequired

namestringrequired
Possible values: non-empty
field_keystringrequired
Name of the form field, also used to store the value
Possible values: non-empty
labelstringrequired
Possible values: non-empty
typePromptTypeEnum (string)required
Possible values: [text, text_area, text_read_only, text_area_read_only, username, email, password, number, checkbox, radio-button-group, dropdown, date, date-time, file, separator, hidden, static, ak-locale]
requiredboolean
placeholderstring
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
initial_valuestring
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
orderinteger
Possible values: >= -2147483648 and <= 2147483647
promptstage_set object[]
Array [
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]
]
]
sub_textstring
placeholder_expressionboolean
initial_value_expressionboolean

Responses

201

application/json

Schema

Schema

pkuuidrequired
namestringrequired
field_keystringrequired
Name of the form field, also used to store the value
labelstringrequired
typePromptTypeEnum (string)required
Possible values: [text, text_area, text_read_only, text_area_read_only, username, email, password, number, checkbox, radio-button-group, dropdown, date, date-time, file, separator, hidden, static, ak-locale]
requiredboolean
placeholderstring
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
initial_valuestring
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
orderinteger
Possible values: >= -2147483648 and <= 2147483647
promptstage_set object[]
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]
]
]
sub_textstring
placeholder_expressionboolean
initial_value_expressionboolean

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "field_key": "string",
  "label": "string",
  "type": "text",
  "required": true,
  "placeholder": "string",
  "initial_value": "string",
  "order": 0,
  "promptstage_set": [
    {
      "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"
        }
      ]
    }
  ],
  "sub_text": "string",
  "placeholder_expression": true,
  "initial_value_expression": 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.Post, "/api/v3/stages/prompt/prompts/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"field_key\": \"string\",\n  \"label\": \"string\",\n  \"type\": \"text\",\n  \"required\": true,\n  \"placeholder\": \"string\",\n  \"initial_value\": \"string\",\n  \"order\": 0,\n  \"promptstage_set\": [\n    {\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    }\n  ],\n  \"sub_text\": \"string\",\n  \"placeholder_expression\": true,\n  \"initial_value_expression\": true\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

Body required

{
  "name": "string",
  "field_key": "string",
  "label": "string",
  "type": "text",
  "required": true,
  "placeholder": "string",
  "initial_value": "string",
  "order": 0,
  "promptstage_set": [
    {
      "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"
        }
      ]
    }
  ],
  "sub_text": "string",
  "placeholder_expression": true,
  "initial_value_expression": true
}