Class Authenticator

Definition

Namespace:

Tizen.Security.WebAuthn

Assembly:

Tizen.Security.WebAuthn.dll

Public web authentication API.

public static class Authenticator

Inheritance

object

Authenticator

Methods

Cancel()

Stops the previous MakeCredential(ClientData, PubkeyCredCreationOptions, MakeCredentialCallbacks) or GetAssertion(ClientData, PubkeyCredRequestOptions, GetAssertionCallbacks) call.

Declaration

public static void Cancel()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the required feature is not supported.
System.InvalidOperationException	Thrown when the operation is invalid in current state.

GetAssertion(ClientData, PubkeyCredRequestOptions, GetAssertionCallbacks)

Gets assertion from the authenticator.

Declaration

public static void GetAssertion(ClientData clientData, PubkeyCredRequestOptions options, GetAssertionCallbacks callbacks)

Parameters

Type	Name	Description
ClientData	clientData	UTF-8 encoded JSON serialization of the client data.
PubkeyCredRequestOptions	options	Specifies the desired attributes of the public key credential to discover.
GetAssertionCallbacks	callbacks	The callback functions to be invoked.

Remarks

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

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the required feature is not supported.
System.UnauthorizedAccessException	Thrown when a required privilege is missing.
System.ArgumentException	Thrown when an input parameter is invalid.
System.InvalidOperationException	Thrown when the operation is invalid in current state.
System.OperationCanceledException	Thrown when the call is canceled by a cancel request.

MakeCredential(ClientData, PubkeyCredCreationOptions, MakeCredentialCallbacks)

Makes a new web authentication credential and stores it to authenticator.

Declaration

public static void MakeCredential(ClientData clientData, PubkeyCredCreationOptions options, MakeCredentialCallbacks callbacks)

Parameters

Type	Name	Description
ClientData	clientData	UTF-8 encoded JSON serialization of the client data.
PubkeyCredCreationOptions	options	Specifies the desired attributes of the to-be-created public key credential.
MakeCredentialCallbacks	callbacks	The callback functions to be invoked.

Remarks

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

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the required feature is not supported.
System.UnauthorizedAccessException	Thrown when a required privilege is missing.
System.ArgumentException	Thrown when an input parameter is invalid.
System.InvalidOperationException	Thrown when the operation is invalid in current state.
System.OperationCanceledException	Thrown when the call is canceled by a cancel request.

SupportedAuthenticators()

Gets information on authenticator types that the client platform supports.

Declaration

public static AuthenticatorTransport SupportedAuthenticators()

Returns

Type	Description
AuthenticatorTransport	An enum with the collection of all supported authenticator types.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the required feature is not supported.