Skip to main content

stages_prompt_prompts_preview_create

POST 
/stages/prompt/prompts/preview/

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

Request​

Body

required

    name stringrequired

    Possible values: non-empty

    field_key stringrequired

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

    Possible values: non-empty

    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

    Visible in the URL.

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

    title stringrequired

    Shown as the Title in Flow pages.

    Possible values: non-empty

    designation FlowDesignationEnum (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_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)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]

  • ]

    • sub_text string
    placeholder_expression boolean
    initial_value_expression boolean

Responses​

Schema

    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

  • ]

Loading...