Show / Hide Table of Contents

GetData Method

GetData()

Returns the number of built-in User Verification (UV) retries remaining for this YubiKey's FIDO application. The only built-in UV method the YubiKey has is the fingerprint reader on the YubiKey Bio Series. The UV retry count is not applicable to non-biometric based YubiKeys.

C#
public int GetData()

Returns

int

The number of UV tries remaining before disabling the built-in fingerprint sensor.

Implements

IYubiKeyResponseWithData<TData>.GetData()

Exceptions

Type Condition
Ctap2DataException

The UV retry count was missing from the response that was returned by the YubiKey.

Remarks

The UV retries counter represents the number of attempts left using the YubiKey's biometric sensor. This only applies to YubiKeys that have an onboard biometric sensor, such as the YubiKey Bio Series.

Applications should alert the user when the number of retries approaches zero. When the number of retries is exhausted, a user will no longer be able to use the fingerprint reader to authenticate. The YubiKey will fall back to the PIN for future authentication attempts. Once the correct PIN has been entered, the number of UV retries will be reset and the fingerprint reader will be unblocked.

In this article
Back to top Generated by DocFX