Sign in
stages

IdentificationStage Viewset

post/stages/identification/

Request body

namestring required
user_fieldsUserFieldsEnum[]

Fields of the user object to match against. (Hold shift to select multiple options)

password_stagestring uuid nullable

When set, shows a password field, instead of showing the password field as separate step.

captcha_stagestring uuid nullable

When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

case_insensitive_matchingboolean

When enabled, user fields are matched regardless of their casing.

show_matched_userboolean

When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown

enrollment_flowstring uuid nullable

Optional enrollment flow, which is linked at the bottom of the page.

recovery_flowstring uuid nullable

Optional recovery flow, which is linked at the bottom of the page.

passwordless_flowstring uuid nullable

Optional passwordless flow, which is linked at the bottom of the page.

sourcesstring[]

Specify which sources should be shown.

show_source_labelsboolean
pretend_user_existsboolean

When enabled, the stage will succeed and continue even when incorrect user info is entered.

enable_remember_meboolean

Show the user the 'Remember me on this device' toggle, allowing repeat users to skip straight to entering their password.

webauthn_stagestring uuid nullable

When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.

Response

pkstring uuid required
namestring required
componentstring required

Get object type so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

user_fieldsUserFieldsEnum[]

Fields of the user object to match against. (Hold shift to select multiple options)

password_stagestring uuid nullable

When set, shows a password field, instead of showing the password field as separate step.

captcha_stagestring uuid nullable

When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

case_insensitive_matchingboolean

When enabled, user fields are matched regardless of their casing.

show_matched_userboolean

When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown

enrollment_flowstring uuid nullable

Optional enrollment flow, which is linked at the bottom of the page.

recovery_flowstring uuid nullable

Optional recovery flow, which is linked at the bottom of the page.

passwordless_flowstring uuid nullable

Optional passwordless flow, which is linked at the bottom of the page.

sourcesstring[]

Specify which sources should be shown.

show_source_labelsboolean
pretend_user_existsboolean

When enabled, the stage will succeed and continue even when incorrect user info is entered.

enable_remember_meboolean

Show the user the 'Remember me on this device' toggle, allowing repeat users to skip straight to entering their password.

webauthn_stagestring uuid nullable

When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.

Changes

No recorded changes to this endpoint across all 1 revision of this API.