Class PubkeyCredRequestOptions

Definition

Namespace:: Tizen.Security.WebAuthn

Assembly:: Tizen.Security.WebAuthn.dll

Get assertion options.

public class PubkeyCredRequestOptions

Inheritance: object

PubkeyCredRequestOptions

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

Constructors

View Source

PubkeyCredRequestOptions(ulong, string, IEnumerable<PubkeyCredDescriptor>, UserVerificationRequirement, IEnumerable<PubkeyCredHint>, AttestationPref, IEnumerable<byte[]>, IEnumerable<AuthenticationExtension>, HybridLinkedData)

Initializes a new instance of the PubkeyCredRequestOptions class.

Declaration

public PubkeyCredRequestOptions(ulong timeout = 0, string rpId = null, IEnumerable<PubkeyCredDescriptor> allowCredentials = null, UserVerificationRequirement userVerification = UserVerificationRequirement.Preferred, IEnumerable<PubkeyCredHint> hints = null, AttestationPref attestation = AttestationPref.None, IEnumerable<byte[]> attestationFormats = null, IEnumerable<AuthenticationExtension> extensions = null, HybridLinkedData linkedDevice = null)

Parameters

Type	Name	Description
ulong	timeout	Specifies a time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client. The value, '0', means no timeout is set. (optional)
string	rpId	Specifies the RP ID claimed by the Relying Party. (optional)
System.Collections.Generic.IEnumerable<T><PubkeyCredDescriptor>	allowCredentials	Used by the client to find authenticators eligible for this authentication ceremony. (optional)
UserVerificationRequirement	userVerification	Specifies the Relying Party's requirements regarding user verification for the GetAssertion() operation. The default value is Preferred. (optional)
System.Collections.Generic.IEnumerable<T><PubkeyCredHint>	hints	Contains zero or more elements from PubkeyCredHint to guide the user agent in interacting with the user. (optional)
AttestationPref	attestation	The Relying Party MAY use this argument to specify a preference regarding attestation conveyance. The default value is None. (optional)
System.Collections.Generic.IEnumerable<T><byte[]>	attestationFormats	The Relying Party MAY use this argument to specify a preference regarding the attestation statement format used by the authenticator. The default value is the empty list, which indicates no preference. (optional)
System.Collections.Generic.IEnumerable<T><AuthenticationExtension>	extensions	The Relying Party MAY use this argument to provide client extension inputs requesting additional processing by the client and authenticator. (optional)
HybridLinkedData	linkedDevice	Linked Device Connection Info. Optional. If not null, the state assisted transaction will start.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

Properties

View Source

AllowCredentials

Gets the list of allowed credentials.

Declaration

public IEnumerable<PubkeyCredDescriptor> AllowCredentials { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><PubkeyCredDescriptor>	Used by the client to find authenticators eligible for this authentication ceremony. The list is ordered in descending order of preference.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

Attestation

Gets the attestation conveyance preference.

Declaration

public AttestationPref Attestation { get; init; }

Property Value

Type	Description
AttestationPref	Specifies a preference regarding attestation conveyance.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

AttestationFormats

Gets the attestation format preference.

Declaration

public IEnumerable<byte[]> AttestationFormats { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><byte[]>	Specifies a preference regarding the attestation statement format used by the authenticator.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

Extensions

Gets the client extension inputs.

Declaration

public IEnumerable<AuthenticationExtension> Extensions { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><AuthenticationExtension>	Client extension inputs requesting additional processing by the client and authenticator.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

Hints

Gets hints used to guide the user agent in interacting with the user.

Declaration

public IEnumerable<PubkeyCredHint> Hints { get; init; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><PubkeyCredHint>	Contains zero or more elements from PubkeyCredHint to guide the user agent in interacting with the user.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

LinkedDevice

Gets the Linked Device Connection Info.

Declaration

public HybridLinkedData LinkedDevice { get; init; }

Property Value

Type	Description
HybridLinkedData	Linked Device Connection Info. If not null, the state assisted transaction will start.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

RpId

Gets the Relying Party ID.

Declaration

public string RpId { get; init; }

Property Value

Type	Description
string	Specifies the RP ID claimed by the Relying Party.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

Timeout

Gets the timeout requested by the Relying Party.

Declaration

public ulong Timeout { get; init; }

Property Value

Type	Description
ulong	The time, in milliseconds, that the Relying Party is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client. The value, '0', means no timeout is set.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options

View Source

UserVerification

Gets the user verification requirements.

Declaration

public UserVerificationRequirement UserVerification { get; init; }

Property Value

Type	Description
UserVerificationRequirement	The Relying Party's requirements regarding user verification for the GetAssertion(ClientData, PubkeyCredRequestOptions, GetAssertionCallbacks) operation.

Remarks

Refer to the following W3C specification for more information. https://www.w3.org/TR/webauthn-3/#dictionary-assertion-options