BioEnrollmentData Class

Namespace: Yubico.YubiKey.Fido2.Commands Assembly: Yubico.YubiKey.dll

Contains the data returned by the YubiKey after calling one of the authenticatorBioEnrollment subcommands.

C#

public class BioEnrollmentData : Object

Inheritance System.Object BioEnrollmentData

Remarks

When a BioEnrollment subcommand is sent to the YubiKey, it returns data encoded following the definition of the authenticatorBioEnrollment response. The FIDO2 standard defines this encoded response as a map of a set of elements. The standard also specifies which subset of the total data is returned by each subcommand.

After calling one of the subcommands, get the data out of the response. It will be an instance of this class. Only those elements the particular subcommand returns will be represented in the object, the rest will be null.

For example, if you call the get modality subcommand, the YubiKey will return the modality (an integer). Hence, the only property with a value will be Modality. All other properties will be null.

Constructors

Name	Description
BioEnrollmentData(ReadOnlyMemory<Byte>)	Build a new instance of BioEnrollmentData based on the given CBOR encoding.

Properties

Name	Description
FingerprintKind	The kind of fingerprint reader, that is, what method the fingerprint reader uses. This is an optional element and can be null.
LastEnrollSampleStatus	The result of the most recent attempt to provide a fingerprint sample. This is an optional element and can be null.
MaxCaptureCount	The number of "good" fingerprint captures required to enroll. This is an optional element and can be null.
MaxFriendlyNameBytes	The maximum length, in bytes, of a template friendly name. This is an optional element and can be null.
Modality	The modality of the YubiKey Bio component. The modality is the technique used to obtain Bio authentication. This is an optional element and can be null.
RemainingSampleCount	The number of successful fingerprint samples required to complete an enrollment. This is an optional element and can be null.
TemplateId	The template ID of the fingerprint being enrolled. This is an optional element and can be null.
TemplateInfos	The enumeration of enrolled fingerprints. This is an optional element and can be null.