Skip to main content

stages_authenticator_webauthn_retrieve

GET 
/stages/authenticator/webauthn/:stage_uuid/

AuthenticatorWebAuthnStage Viewset

Request​

Path Parameters

    stage_uuid uuidrequired

    A UUID string identifying this WebAuthn Authenticator Setup Stage.

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]

  • ]

    • configure_flow uuidnullable

    Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

    friendly_name stringnullable
    user_verification UserVerificationEnum (string)

    Possible values: [required, preferred, discouraged]

    authenticator_attachment AuthenticatorAttachmentEnum (string)

    Possible values: [platform, cross-platform]

    resident_key_requirement ResidentKeyRequirementEnum (string)

    Possible values: [discouraged, preferred, required]

    device_type_restrictions uuid[]

    device_type_restrictions_obj

    object[]

    required

  • Array [

    • aaguid uuidrequired
    description stringrequired

  • ]

Loading...