- Qt 6.9
- Qt WebEngine
- QML Types
- webEngineWebAuthPinRequest
- Qt 6.9.1 Reference Documentation

# webEngineWebAuthPinRequest QML Value Type

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

Import Statement: | `import QtWebEngine`
Since: | QtWebEngine 6.8

## Properties

- error : enumeration
- minPinLength : int
- reason : enumeration
- remainingAttempts : int

## Detailed Description

This encapsulates the following information related to a PIN request made by an authenticator.

- The reason for the PIN prompt.
- The error details for the PIN prompt.
- The number of attempts remaining before a hard lock. Should be ignored unless webEngineWebAuthPinRequest::reason is `WebEngineWebAuthUxRequest.PinEntryReason.Challenge`.
- The minimum PIN length that the authenticator will accept for the PIN.

Use this structure to update the WebAuth UX dialog when the WebAuth UX state is `WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin`.

## Property Documentation

error : enumeration

The error details for the PIN prompt.

Constant | Description
--- | ---
`WebEngineWebAuthUxRequest.PinEntryError.NoError` | No error has occurred.
`WebEngineWebAuthUxRequest.PinEntryError.InternalUvLocked` | Internal UV is locked, so we are falling back to PIN.
`WebEngineWebAuthUxRequest.PinEntryError.WrongPin` | The PIN the user entered does not match the authenticator PIN.
`WebEngineWebAuthUxRequest.PinEntryError.TooShort` | The new PIN the user entered is too short.
`WebEngineWebAuthUxRequest.PinEntryError.InvalidCharacters` | The new PIN the user entered contains invalid characters.
`WebEngineWebAuthUxRequest.PinEntryError.SameAsCurrentPin` | The new PIN the user entered is the same as the currently set PIN.

minPinLength : int

The minimum PIN length that the authenticator will accept for the PIN.

reason : enumeration

The reason for the PIN prompt.

Constant | Description
--- | ---
`WebEngineWebAuthUxRequest.PinEntryReason.Set` | A new PIN is being set.
`WebEngineWebAuthUxRequest.PinEntryReason.Change` | The existing PIN must be changed before using this authenticator.
`WebEngineWebAuthUxRequest.PinEntryReason.Challenge` | The existing PIN is being collected to prove user verification.

remainingAttempts : int

The number of attempts remaining before a hard lock. Should be ignored unless webEngineWebAuthPinRequest::reason is `WebEngineWebAuthUxRequest.PinEntryReason.Challenge`.