Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 3.09 KB

IdentificationStage.md

File metadata and controls

49 lines (40 loc) · 3.09 KB

IdentificationStage

IdentificationStage Serializer

Properties

Name Type Description Notes
pk UUID [readonly]
name str
component str Get object type so that we know how to edit the object [readonly]
verbose_name str Return object's verbose_name [readonly]
verbose_name_plural str Return object's plural verbose_name [readonly]
meta_model_name str Return internal model name [readonly]
flow_set List[FlowSet] [readonly]
user_fields List[UserFieldsEnum] Fields of the user object to match against. (Hold shift to select multiple options) [optional]
password_stage UUID When set, shows a password field, instead of showing the password field as separate step. [optional]
captcha_stage UUID When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage. [optional]
case_insensitive_matching bool When enabled, user fields are matched regardless of their casing. [optional]
show_matched_user bool 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 [optional]
enrollment_flow UUID Optional enrollment flow, which is linked at the bottom of the page. [optional]
recovery_flow UUID Optional recovery flow, which is linked at the bottom of the page. [optional]
passwordless_flow UUID Optional passwordless flow, which is linked at the bottom of the page. [optional]
sources List[UUID] Specify which sources should be shown. [optional]
show_source_labels bool [optional]
pretend_user_exists bool When enabled, the stage will succeed and continue even when incorrect user info is entered. [optional]
enable_remember_me bool Show the user the 'Remember me on this device' toggle, allowing repeat users to skip straight to entering their password. [optional]
webauthn_stage UUID When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor. [optional]

Example

from authentik_client.models.identification_stage import IdentificationStage

# TODO update the JSON string below
json = "{}"
# create an instance of IdentificationStage from a JSON string
identification_stage_instance = IdentificationStage.from_json(json)
# print the JSON string representation of the object
print(IdentificationStage.to_json())

# convert the object into a dict
identification_stage_dict = identification_stage_instance.to_dict()
# create an instance of IdentificationStage from a dict
identification_stage_from_dict = IdentificationStage.from_dict(identification_stage_dict)

[Back to Model list] [Back to API list] [Back to README]