- Qt 6.8
- Qt WebEngine
- QML Types
- WebEngineWebAuthUxRequest
- Qt 6.8.1 Reference Documentation

# WebEngineWebAuthUxRequest QML Type

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

Import Statement: | `import QtWebEngine`
Since: | QtWebEngine 6.7
In C++: | 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

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.

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

See also stateChanged().

state : enumeration `[read-only]`

The WebAuth request's current UX state.

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