EnumerateCredentialsBeginCommand Class

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

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

C#

public class EnumerateCredentialsBeginCommand : CredentialMgmtSubCommand, IYubiKeyCommand<EnumerateCredentialsBeginResponse>

Inheritance object CredentialMgmtSubCommand EnumerateCredentialsBeginCommand

Implements

IYubiKeyCommand<EnumerateCredentialsBeginResponse>

Remarks

The partner Response class is EnumerateCredentialsBeginResponse.

This returns the total number of credentials for the given relying party on the YubiKey along with information on the "first" credential. If there is only one credential, then you have all the information you need. If there are more credentials, then you can get information on all of them by calling the enumerateCredentialsGetNextRP subcommand.

Note that if there are no credentials associated with the given relying party, the response will be "No Data" (Status = ResponseStatus.NoData, and CtapStatus = CtapStatus.NoCredentials). In this case, calling the response.GetData() method will result in an exception.

The return from this command consist of the user, credentialId, publicKey, credProtect, largeBlobKey, and credentialCount.

Constructors

Name	Description
EnumerateCredentialsBeginCommand(RelyingParty, ReadOnlyMemory<byte>, PinUvAuthProtocolBase)	Constructs a new instance of EnumerateCredentialsBeginCommand.

Methods

Name	Description
CreateResponseForApdu(ResponseApdu)	Creates the corresponding IYubiKeyResponse implementation for the current command.