WebEngineWebAuthUxRequest QML Type

Encapsulates the data of a WebAuth UX request. More...

Import Statement: import QtWebEngine
Since: QtWebEngine 6.7
Instantiates: QWebEngineWebAuthUxRequest




Detailed Description

Web engine's WebAuth UX requests are passed to the user in the WebEngineView::webAuthUxRequested() signal.

For more information about how to handle web engine authenticator requests, see the Nano Browser.

Property Documentation

pinRequest : QWebEngineWebAuthPinRequest [read-only]

The WebAuth request's PIN request information.

See also QWebEngineWebAuthPinRequest.

relyingPartyId : string [read-only]

The WebAuth request's relying party id.

requestFailureReason : enumeration [read-only]

The WebAuth request's failure reason.

WebEngineWebAuthUxRequest.RequestFailureReason.TimeoutThe authentication session has timed out.
WebEngineWebAuthUxRequest.RequestFailureReason.KeyNotRegisteredKey is not registered with the authenticator.
WebEngineWebAuthUxRequest.RequestFailureReason.KeyAlreadyRegisteredKey is already registered with the authenticator. Try to register with another key or use another authenticator.
WebEngineWebAuthUxRequest.RequestFailureReason.SoftPinBlockThe authenticator is blocked as the user entered the wrong key many times.
WebEngineWebAuthUxRequest.RequestFailureReason.HardPinBlockThe authenticator is blocked as the user entered the wrong key many times and reset the PIN to use the specific authenticator again.
WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorRemovedDuringPinEntryAuthenticator removed during PIN entry.
WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingResidentKeysAuthenticator doesn't have resident key support.
WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingUserVerificationAuthenticator doesn't have user verification support.
WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingLargeBlobAuthenticator doesn't have large blob support.
WebEngineWebAuthUxRequest.RequestFailureReason.NoCommonAlgorithmsNo common algorithm.
WebEngineWebAuthUxRequest.RequestFailureReason.StorageFullThe resident credential could not be created because the authenticator has insufficient storage.
WebEngineWebAuthUxRequest.RequestFailureReason.UserConsentDeniedUser consent denied.
WebEngineWebAuthUxRequest.RequestFailureReason.WinUserCancelledThe user clicked Cancel in the native windows UI.

See also stateChanged().

state : enumeration [read-only]

The WebAuth request's current UX state.

WebEngineWebAuthUxRequest.WebAuthUxState.NotStartedWebAuth UX request not started yet.
WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccountThe authenticator requires resident credential details. The application needs to display an account details dialog, and the user needs to select an account to proceed.
WebEngineWebAuthUxRequest.WebAuthUxState.CollectPinThe authenticator requires user verification. The application needs to display a PIN request dialog.
WebEngineWebAuthUxRequest.WebAuthUxState.FinishTokenCollectionThe authenticator requires token/user verification (like tap on the FIDO key) to complete the process.
WebEngineWebAuthUxRequest.WebAuthUxState.RequestFailedWebAuth request failed. Display error details.
WebEngineWebAuthUxRequest.WebAuthUxState.CancelledWebAuth request is cancelled. Close the WebAuth dialog.
WebEngineWebAuthUxRequest.WebAuthUxState.CompletedWebAuth request is completed. Close the WebAuth dialog.

userNames : stringlist [read-only]

The available user names for the resident credential support.

This is needed when the current WebAuth request's UX state is WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccount. The WebAuth dialog displays user names. The user needs to select an account to proceed.

See also state, setSelectedAccount(), and QWebEngineWebAuthUxRequest::userNames.

Signal Documentation

void stateChanged(WebAuthUxState state)

This signal is emitted whenever the WebAuth UX's state changes.

Note: The corresponding handler is onStateChanged.

See also state and QWebEngineWebAuthUxRequest::WebAuthUxState.

Method Documentation

void cancel()

Cancels the current WebAuth request.

See also QWebEngineWebAuthUxRequest::Cancelled and WebEngineWebAuthUxRequest::stateChanged().

void retry()

Retries the current WebAuth request.

See also stateChanged().

void setPin(const QString &pin)

Sends the pin to the authenticator that prompts for a PIN. This is needed when the current WebAuth request's UX state is WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin. The WebAuth request is blocked until the user responds with a PIN.

See also QWebEngineWebAuthPinRequest and state.

void setSelectedAccount(const QString &selectedAccount)

Sends the selectedAccount name to the authenticator. This is needed when the current WebAuth request's UX state is WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccount. The WebAuth request is blocked until the user selects an account and invokes this method.

See also WebEngineWebAuthUxRequest::userNames and state.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.