Skip to main content

stages_identification_partial_update

PATCH 
/stages/identification/:stage_uuid/

IdentificationStage Viewset

Request​

Path Parameters

    stage_uuid uuidrequired

    A UUID string identifying this Identification Stage.

Body

    name string

    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]

  • ]

    • user_fields UserFieldsEnum (string)[]

    Possible values: [email, username, upn]

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

    password_stage uuidnullable

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

    case_insensitive_matching boolean

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

    show_matched_user boolean

    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_flow uuidnullable

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

    recovery_flow uuidnullable

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

    passwordless_flow uuidnullable

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

    sources uuid[]

    Specify which sources should be shown.

    show_source_labels boolean
    pretend_user_exists boolean

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

Responses​

Schema

    pk uuidrequired
    name stringrequired
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

    background stringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

  • ]

    • user_fields UserFieldsEnum (string)[]

    Possible values: [email, username, upn]

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

    password_stage uuidnullable

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

    case_insensitive_matching boolean

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

    show_matched_user boolean

    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_flow uuidnullable

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

    recovery_flow uuidnullable

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

    passwordless_flow uuidnullable

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

    sources uuid[]

    Specify which sources should be shown.

    show_source_labels boolean
    pretend_user_exists boolean

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

Loading...