EnumerateRelyingParties Method

EnumerateRelyingParties()

This performs the enumerateRPs (Begin and GetNextRP) subcommands of the authenticatorCredentialManagement command. It gets a list of all the relying parties represented in all the discoverable credentials on the YubiKey.

C#
public IReadOnlyList<RelyingParty> EnumerateRelyingParties()

Returns

System.Collections.Generic.IReadOnlyList<RelyingParty>

A list of RelyingParty objects.

Exceptions

Type Condition
System.InvalidOperationException

The connected YubiKey does not support CredentialManagement, or the PIN was invalid, or there was no KeyCollector.
System.OperationCanceledException

The user canceled the operation while collecting the PIN.
System.Security.SecurityException

The PIN retry count was exhausted.

Remarks

See the User's Manual entry on credential management.

This method returns a list of RelyingParty objects. Each object contains information about one of the relying parties represented on the YubiKey. If there are no discoverable credentials on the YubiKey, then the list will have no elements (Count will be zero).

Note that other FIDO2 operations require the "RelyingPartyIdHash", which is one of the properties of the RelyingParty object.