Class EnumerateCredentialsBeginResponse

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

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.

public class EnumerateCredentialsBeginResponse : Fido2Response, IYubiKeyResponseWithData<(int credentialCount, CredentialUserInfo credentialUserInfo)>, IYubiKeyResponse

Inheritance

object

YubiKeyResponse

Fido2Response

EnumerateCredentialsBeginResponse

Implements

IYubiKeyResponseWithData<(int credentialCount, CredentialUserInfo credentialUserInfo)>

IYubiKeyResponse

Inherited Members

Fido2Response.CtapStatus

Fido2Response.StatusCodeMap

YubiKeyResponse.ResponseApdu

YubiKeyResponse.Status

YubiKeyResponse.StatusWord

YubiKeyResponse.StatusMessage

YubiKeyResponse.ToString()

Remarks

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

Constructors

EnumerateCredentialsBeginResponse(ResponseApdu)

Constructs a new instance of EnumerateCredentialsBeginResponse based on a response APDU provided by the YubiKey.

public EnumerateCredentialsBeginResponse(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

A response APDU containing the CBOR response data for the authenticatorCredentialManagement command.

Methods

GetData()

Gets the total number of credentials and the first (index 0) set of credential info associated with the given relying party in the YubiKey.

public (int credentialCount, CredentialUserInfo credentialUserInfo) GetData()

Returns

(int credentialCount, CredentialUserInfo credentialUserInfo)

The data in the response APDU, presented as a Tuple of (int,CredentialUserInfo).

Remarks

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

Exceptions

InvalidOperationException

Thrown when Status is not Success.

Ctap2DataException

If the response from the YubiKey does not match the expected format.