Skip to main content

stages_authenticator_validate_update

PUT 
/stages/authenticator/validate/:stage_uuid/

AuthenticatorValidateStage Viewset

Request​

Path Parameters

    stage_uuid uuidrequired

    A UUID string identifying this Authenticator Validation Stage.

Body

required

    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]

  • ]

    • not_configured_action NotConfiguredActionEnum (string)

    Possible values: [skip, deny, configure]

    device_classes DeviceClassesEnum (string)[]

    Device classes which can be used to authenticate

    Possible values: [static, totp, webauthn, duo, sms]

    configuration_stages uuid[]

    Stages used to configure Authenticator when user doesn't have any compatible devices. After this configuration Stage passes, the user is not prompted again.

    last_auth_threshold string

    If any of the user's device has been used within this threshold, this stage will be skipped

    Possible values: non-empty

    webauthn_user_verification UserVerificationEnum (string)

    Enforce user verification for WebAuthn devices.

    Possible values: [required, preferred, discouraged]

    webauthn_allowed_device_types uuid[]

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

    Visible in the URL.

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

    title stringrequired

    Shown as the Title in Flow pages.

    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]

    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)

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

    Possible values: [message_continue, message, continue]

  • ]

    • not_configured_action NotConfiguredActionEnum (string)

    Possible values: [skip, deny, configure]

    device_classes DeviceClassesEnum (string)[]

    Device classes which can be used to authenticate

    Possible values: [static, totp, webauthn, duo, sms]

    configuration_stages uuid[]

    Stages used to configure Authenticator when user doesn't have any compatible devices. After this configuration Stage passes, the user is not prompted again.

    last_auth_threshold string

    If any of the user's device has been used within this threshold, this stage will be skipped

    webauthn_user_verification UserVerificationEnum (string)

    Enforce user verification for WebAuthn devices.

    Possible values: [required, preferred, discouraged]

    webauthn_allowed_device_types uuid[]

    webauthn_allowed_device_types_obj

    object[]

    required

  • Array [

    • aaguid uuidrequired
    description stringrequired

  • ]

Loading...