Show / Hide Table of Contents

Classes

BioEnrollBeginCommand

Begins the process of enrolling a fingerprint. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollBeginResponse

The response partner to the GetBioModalityCommand, containing information about the biometric technique of the YubiKey.

BioEnrollCancelCommand

Cancel the current BioEnrollment process. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollEnumerateCommand

Enumerate the enrolled fingerprints. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollEnumerateResponse

The response partner to the BioEnrollEnumerateCommand.

BioEnrollNextSampleCommand

Continue the process of enrolling a fingerprint. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollNextSampleResponse

The response partner to the BioEnrollNextSampleCommand.

BioEnrollRemoveCommand

Remove an enrolled fingerprint. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollSetFriendlyNameCommand

Set the friendly name of an enrolled fingerprint. If there is a friendly name already, this replaces it. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

BioEnrollmentCommand

The BioEnrollmentCommand is the class for authenticatorBioEnrollment. This command has a number of subcommands, each of which is represented by its own class.

BioEnrollmentData

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

BioEnrollmentResponse

The response partner to the BioEnrollmentCommand.

ChangePinCommand

Change the YubiKey's FIDO2 application PIN.

ChangePinResponse

This is the partner response class to the ChangePinCommand class.

ClientPinCommand

The ClientPinCommand allows a client or platform to use a PIN/UV auth protocol to perform a number of actions such as authenticating the PIN, setting and changing the PIN, and getting the number of PIN retries left.

ClientPinData

The results of a call to the ClientPinCommand command class.

ClientPinResponse

The response partner to ClientPinCommand.

ConfigCommand

The ConfigCommand is the class for authenticatorConfig. This command has a number of subcommands, each of which is represented by its own class. You will likely never use this class directly, but it does contain code shared by all the subcommands.

ConfigResponse

The response to the ConfigCommand, containing the response from the YubiKey.

CredentialManagementCommand

The CredentialManagementCommand is the class for authenticatorCredentialManagement. This command has a number of subcommands, each of which is represented by its own class. You will likely never use this class directly, but it does contain code shared by all the subcommands.

CredentialManagementData

Parses the data returned by the YubiKey after calling one of the authenticatorCredentialManagement subcommands. This class is relevant only to the class in order to extract data from a response.

CredentialManagementResponse

The response partner to the CredentialManagementCommand.

CredentialMgmtSubCommand

A base class for CredentialManagementCommand classes to share code.

DeleteCredentialCommand

Delete a credential.

EnableEnterpriseAttestationCommand

Make sure the enterprise attestation feature is enabled.

EnumerateCredentialsBeginCommand

Begin the process of getting information on all the credentials associated with a specific relying party stored on the YubiKey.

EnumerateCredentialsBeginResponse

The response partner to the EnumerateCredentialsBeginCommand, containing the the total number of credentials associated with the given relying party, along with the "first" (index 0) set of credential info.

EnumerateCredentialsGetNextCommand

Continue the process of getting information on all the credentials associated with a specific relying party stored on the YubiKey.

EnumerateCredentialsGetNextResponse

The response partner to the EnumerateCredentialsGetNextCommand, containing the next credential associated with a specified relying party.

EnumerateRpsBeginCommand

Begin the process of getting information on all the relying parties represented in credentials on the YubiKey.

EnumerateRpsBeginResponse

The response partner to the EnumerateRpsBeginCommand, containing the total number of relying parties represented in the YubiKey along with the "first" (index 0) relying party.

EnumerateRpsGetNextCommand

Continue the process of getting information on all the relying parties represented in credentials on the YubiKey, by getting the next RP.

EnumerateRpsGetNextResponse

The response partner to the EnumerateRpsGetNextCommand, containing the next relying party represented in the YubiKey.

Fido2Response
GetAssertionCommand

Instruct the YubiKey to get an assertion based on the input parameters.

GetAssertionResponse

This is the partner response class to the GetAssertionCommand command class.

GetBioModalityCommand

Gets the modality of the BioEnrollment. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

GetBioModalityResponse

The response partner to the GetBioModalityCommand, containing information about the biometric technique of the YubiKey.

GetCredentialMetadataCommand

Get the YubiKey's FIDO2 credential metadata.

GetCredentialMetadataResponse

The response partner to the GetCredentialMetadataCommand, containing information about the discoverable credentials on the YubiKey.

GetFingerprintSensorInfoCommand

Gets information about the fingerprint sensor. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

GetFingerprintSensorInfoResponse

The response partner to the GetFingerprintSensorInfoCommand, containing information about the fingerprint technique of the YubiKey.

GetInfoCommand

Gets detailed information about the authenticator.

GetInfoResponse

The response to the GetInfoCommand command, containing information about the device and FIDO2 application.

GetKeyAgreementCommand

Gets the YubiKey's public key for the Key Agreement algorithm based on the specified PIN/UV auth protocol.

GetKeyAgreementResponse

This is the partner response class to the GetKeyAgreementCommand command class.

GetLargeBlobCommand

Gets the large blob out of the YubiKey.

GetLargeBlobResponse

The response to the GetLargeBlobCommand command, returning the large blob.

GetNextAssertionCommand

Instruct the YubiKey to get the next assertion associated with the relying party specified in the previous call to GetAssertionCommand.

GetPinRetriesCommand

Gets the number of PIN retries remaining for FIDO2.

GetPinRetriesResponse

This is the partner response class to the GetPinRetriesCommand command class.

GetPinTokenCommand

Gets a new PIN token.

GetPinUvAuthTokenResponse

This is the partner response class to the GetPinTokenCommand, GetPinUvAuthTokenUsingPinCommand, and GetPinUvAuthTokenUsingUvCommand, command classes.

GetPinUvAuthTokenUsingPinCommand

Gets a new PIN/UV Auth token using the subcommand getPinUvAuthTokenUsingPinWithPermissions.

GetPinUvAuthTokenUsingUvCommand

Gets a new PIN/UV Auth token using getPinUvAuthTokenUsingUvWithPermissions.

GetUvRetriesCommand

Gets the number of UV retries remaining for FIDO2.

GetUvRetriesResponse

This is the partner response class to the GetUvRetriesCommand command class.

MakeCredentialCommand

Instruct the YubiKey to make a credential based on the input parameters.

MakeCredentialResponse

This is the partner response class to the MakeCredentialCommand command class.

PinUvAuthTokenPermissionsExtensions

Extension methods to operate on the PivAlgorithm enum.

ResetCommand

Instruct the YubiKey to reset the FIDO2 application.

ResetResponse

The response to the ResetCommand, containing the response from the YubiKey.

SetLargeBlobCommand

Stores arbitrary data on the YubiKey. This command does not format the data (the FIDO2 standard specifies a format for serializedLargeBlobArray), it simply stores whatever byte array it is given.

Warning

While storing arbitrary data that does not follow the standard's formatting specification is possible, it is not recommended. See the User's Manual entry on FIDO2 Blobs and the documentation for the method SetSerializedLargeBlobArray(SerializedLargeBlobArray).

SetLargeBlobResponse

The response to the GetLargeBlobCommand command, returning the large blob.

SetMinPinLengthCommand

Set the minimum PIN length, and/or provide a list of relying party IDs that specify which relying parties can see the minimum PIN length, and/or specify whether the PIN must be changed before PIN verification can succeed.

SetPinCommand

Set the YubiKey's FIDO2 application to be PIN-protected.

SetPinResponse

This is the partner response class to the SetPinCommand class.

TemplateInfo

Holds the template information for one enrolled fingerprint.

ToggleAlwaysUvCommand

Toggle the "alwaysUv" feature. That is, if it is set to true, set it to false, and if it is false, set it to true.

UpdateUserInfoCommand

Update the user information for a credential stored on the YubiKey.

Enums

PinUvAuthTokenPermissions

Permission flags used to scope the abilities of the PIN / UV auth token.

In this article
Back to top Generated by DocFX