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

application/json

Body

required

name stringrequired

Possible values: non-empty

field_key stringrequired

Possible values: non-empty

Name of the form field, also used to store the value

label stringrequired

Possible values: non-empty

type PromptTypeEnum (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]

required boolean
placeholder string

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_value string

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.

order integer

Possible values: >= -2147483648 and <= 2147483647

promptstage_set

object[]

Array [

name stringrequired

Possible values: non-empty

flow_set

object[]

Array [

name stringrequired

Possible values: non-empty

slug stringrequired

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

Visible in the URL.

title stringrequired

Possible values: non-empty

Shown as the Title in Flow pages.

designation FlowDesignationEnum (string)required

Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

policy_engine_mode PolicyEngineMode (string)

Possible values: [all, any]

compatibility_mode boolean

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

layout FlowLayoutEnum (string)

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

denied_action DeniedActionEnum (string)

Possible values: [message_continue, message, continue]

]

]

sub_text string
placeholder_expression boolean
initial_value_expression boolean

Responses

200

application/json

Schema

Schema

type ChallengeChoices (string)required

Possible values: [native, shell, redirect]

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-prompt

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

fields

object[]

required

Array [

field_key stringrequired

label stringrequired

type PromptTypeEnum (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]

required booleanrequired

placeholder stringrequired

initial_value stringrequired

order integerrequired

sub_text stringrequired

choices string[]nullablerequired

]

Example (from schema)

{
  "type": "native",
  "flow_info": {
    "title": "string",
    "background": "string",
    "cancel_url": "string",
    "layout": "stacked"
  },
  "component": "ak-stage-prompt",
  "response_errors": {},
  "fields": [
    {
      "field_key": "string",
      "label": "string",
      "type": "text",
      "required": true,
      "placeholder": "string",
      "initial_value": "string",
      "order": 0,
      "sub_text": "string",
      "choices": [
        "string"
      ]
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

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

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
}