WebEngineWebAuthUXRequest QML Type | Qt WebEngine 6.7.0
Description: Encapsulates the data of a WebAuth UX request.

- Qt 6.7
- Qt WebEngine
- QML Types
- WebEngineWebAuthUXRequest
- Qt 6.7.0 Reference Documentation

# WebEngineWebAuthUXRequest QML Type

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

Import Statement: | import QtWebEngine
Since: | QtWebEngine 6.7
Instantiates: | QWebEngineWebAuthUXRequest

- List of all members, including inherited members

## Properties

- pinRequest : QWebEngineWebAuthPINRequest
- relyingPartyId : string
- requestFailureReason : enumeration
- state : enumeration
- userNames : stringlist

## Signals

- void stateChanged(WebAuthUXState state)

## Methods

- void cancel()
- void retry()
- void setPin(const QString &pin)
- void setSelectedAccount(const QString &selectedAccount)

## 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

[read-only] pinRequest : QWebEngineWebAuthPINRequest

The WebAuth request's PIN request information.

See also QWebEngineWebAuthPINRequest.

[read-only] relyingPartyId : string

The WebAuth request's relying party id.

[read-only] requestFailureReason : enumeration

The WebAuth request's failure reason.

Constant | Description
--- | ---
`WebEngineWebAuthUXRequest.Timeout` | The authentication session has timed out.
`WebEngineWebAuthUXRequest.KeyNotRegistered` | Key is not registered with the authenticator.
`WebEngineWebAuthUXRequest.KeyAlreadyRegistered` | Key is already registered with the authenticator. Try to register with another key or use another authenticator.
`WebEngineWebAuthUXRequest.SoftPINBlock` | The authenticator is blocked as the user entered the wrong key many times.
`WebEngineWebAuthUXRequest.HardPINBlock` | The authenticator is blocked as the user entered the wrong key many times and reset the PIN to use the specific authenticator again.
`WebEngineWebAuthUXRequest.AuthenticatorRemovedDuringPINEntry` | Authenticator removed during PIN entry.
`WebEngineWebAuthUXRequest.AuthenticatorMissingResidentKeys` | Authenticator doesn't have resident key support.
`WebEngineWebAuthUXRequest.AuthenticatorMissingUserVerification` | Authenticator doesn't have user verification support.
`WebEngineWebAuthUXRequest.AuthenticatorMissingLargeBlob` | Authenticator doesn't have large blob support.
`WebEngineWebAuthUXRequest.NoCommonAlgorithms` | No common algorithm.
`WebEngineWebAuthUXRequest.StorageFull` | The resident credential could not be created because the authenticator has insufficient storage.
`WebEngineWebAuthUXRequest.UserConsentDenied` | User consent denied.
`WebEngineWebAuthUXRequest.WinUserCancelled` | The user clicked Cancel in the native windows UI.

See also stateChanged().

[read-only] state : enumeration

The WebAuth request's current UX state.

Constant | Description
--- | ---
`WebEngineWebAuthUXRequest.NotStarted` | WebAuth UX request not started yet.
`WebEngineWebAuthUXRequest.SelectAccount` | The 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.CollectPIN` | The authenticator requires user verification. The application needs to display a PIN request dialog.
`WebEngineWebAuthUXRequest.FinishTokenCollection` | The authenticator requires token/user verification (like tap on the FIDO key) to complete the process.
`WebEngineWebAuthUXRequest.RequestFailed` | WebAuth request failed. Display error details.
`WebEngineWebAuthUXRequest.Cancelled` | WebAuth request is cancelled. Close the WebAuth dialog.
`WebEngineWebAuthUXRequest.Completed` | WebAuth request is completed. Close the WebAuth dialog.

[read-only] userNames : stringlist

The available user names for the resident credential support.

This is needed when the current WebAuth request's UX state is WebEngineWebAuthUXRequest.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.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.SelectAccount. The WebAuth request is blocked until the user selects an account and invokes this method.

See also WebEngineWebAuthUXRequest::userNames and state.