SetMinPinLengthCommand Constructor

SetMinPinLengthCommand(Nullable<Int32>, IReadOnlyList<String>, Nullable<Boolean>, ReadOnlyMemory<Byte>, PinUvAuthProtocolBase)

Constructs a new instance of SetMinPinLengthCommand.

C#

public SetMinPinLengthCommand(Nullable<int> newMinPinLength, IReadOnlyList<string> relyingPartyIds, Nullable<bool> forceChangePin, ReadOnlyMemory<byte> pinUvAuthToken, PinUvAuthProtocolBase authProtocol)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	newMinPinLength	The new PIN length, measured in code points. See the User's Manual entry on the FIDO2 PIN for more information on PIN composition. Pass in null to indicate the command should not change the minimum PIN length.
System.Collections.Generic.IReadOnlyList<System.String>	relyingPartyIds	A list of strings that are the relying party IDs for those RPs that are allowed to see the minimum PIN length. Pass in null to indicate the command should not add any RP IDs.
System.Nullable<System.Boolean>	forceChangePin	If you want to set the YubiKey to require the user change the PIN before the verification event, pass in true. If you pass in null or false, this command will consider the force PIN option not taken.
System.ReadOnlyMemory<System.Byte>	pinUvAuthToken	The PIN/UV Auth Token built from the PIN. This is the encrypted token key.
PinUvAuthProtocolBase	authProtocol	The Auth Protocol used to build the Auth Token.

Remarks

There are up to three elements to set with this command: a new minimum PIN length, a new list of relying party IDs, and an indication to require the user change the PIN. All three are optional, although this command will do nothing if none are set (i.e. the first three args are null, null, null).

If you want to set an element, provide a value for the corresponding argument, otherwise, pass in null.

If you want to force a PIN change, pass in true for the forceChangePin arg. If you pass in false, this class will consider it the same as null. That is, the forceChangePin element of this command is optional, meaning the command does not need to include the element (i.e. leave it blank in the command sent to the YubiKey). If you pass in false, this class will send the command without that element (i.e., it will be left blank).