stages

Prompt Viewset

post/stages/prompt/prompts/

Request

  • Base URL: https://api.goauthentik.io/api/v3
  • URL: https://api.goauthentik.io/api/v3/stages/prompt/prompts/
  • Auth: HTTP bearer

Request body

namestring required
field_keystring required

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

labelstring required
type'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' | 'alert_info' | 'alert_warning' | 'alert_danger' | 'ak-locale' required
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
sub_textstring
placeholder_expressionboolean
initial_value_expressionboolean

Response

pkstring uuid required
namestring required
field_keystring required

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

labelstring required
type'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' | 'alert_info' | 'alert_warning' | 'alert_danger' | 'ak-locale' required
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
sub_textstring
placeholder_expressionboolean
initial_value_expressionboolean

Changes

No recorded changes to this operation across all 22 revisions of this API.