Skip to main content

stages_prompt_prompts_preview_create

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

Preview a prompt as a challenge, just like a flow would receive

Request​

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​

Schema
    flow_info object

    Contextual flow information for a challenge

    titlestring
    backgroundstring
    cancel_urlstringrequired
    layoutContextualFlowInfoLayoutEnum (string)required

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

    componentstring
    Default value: ak-stage-prompt
    response_errors object
    property name* object[]
  • Array [
    • stringstringrequired
    codestringrequired
  • ]
    • fields object[]required
  • Array [
    • field_keystringrequired
    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]

    requiredbooleanrequired
    placeholderstringrequired
    initial_valuestringrequired
    orderintegerrequired
    sub_textstringrequired
    choicesstring[]nullablerequired
  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/stages/prompt/prompts/preview/");
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
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
}