Class VirtualAuthenticatorOptions

Namespace

OpenQA.Selenium.VirtualAuth

Assembly

WebDriver.dll

Options for the creation of virtual authenticators. Refer https://w3c.github.io/webauthn/#sctn-automation

public class VirtualAuthenticatorOptions

Inheritance

object

VirtualAuthenticatorOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

SetHasResidentKey(bool)

If set to true, the authenticator will support Client-side discoverable Credentials.

public VirtualAuthenticatorOptions SetHasResidentKey(bool hasResidentKey)

Parameters

hasResidentKey bool

Whether authenticator will support client-side discoverable credentials.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

SetHasUserVerification(bool)

If set to true, the authenticator will support User Verification.

public VirtualAuthenticatorOptions SetHasUserVerification(bool hasUserVerification)

Parameters

hasUserVerification bool

Whether the authenticator supports user verification.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

SetIsUserConsenting(bool)

If set to true, a User Consent will always be granted.

public VirtualAuthenticatorOptions SetIsUserConsenting(bool isUserConsenting)

Parameters

isUserConsenting bool

Whether a user consent will always be granted.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

SetIsUserVerified(bool)

If set to true, User Verification will always succeed.

public VirtualAuthenticatorOptions SetIsUserVerified(bool isUserVerified)

Parameters

isUserVerified bool

Whether User Verification will always succeed.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

SetProtocol(string)

Sets the Client to Authenticator Protocol (CTAP) this Virtual Authenticator speaks.

public VirtualAuthenticatorOptions SetProtocol(string protocol)

Parameters

protocol string

The CTAP protocol identifier.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

Remarks

Valid protocols are available on the VirtualAuthenticatorOptions.Protocol type.

Exceptions

ArgumentException

If protocol is not a supported protocol value.

SetTransport(string)

Sets the Authenticator Transport this Virtual Authenticator needs to implement, to communicate with clients.

public VirtualAuthenticatorOptions SetTransport(string transport)

Parameters

transport string

Valid transport value.

Returns

VirtualAuthenticatorOptions

This options instance for chaining.

Remarks

Valid protocols are available on the VirtualAuthenticatorOptions.Transport type.

Exceptions

ArgumentException

If transport is not a supported transport value.

ToDictionary()

Serializes this set of options into a dictionary of key-value pairs.

public Dictionary<string, object> ToDictionary()

Returns

Dictionary<string, object>

The dictionary containing the values of this set of options.