The object in charge of interacting with the user to do PIN authentication.

The SDK does not provide implementations of this interface. The implementation must be done by the user of the SDK if the PIN authenticator is required.

Hierarchy

  • PinUserVerifier

Methods

  • The user verification interaction.

    In the case of the registration the user must provide credentials again as required by the FIDO UAF protocol. In the case of the authentication, this is invoked for the user to provide credentials.

    If there is a recoverable error during the verification, this method will be invoked again, and the PinUserVerificationContext.lastRecoverableError will contain the error. The recoverable error can be used to inform the user of the recoverable error that occurred, because the UI is the responsibility of the developer using the SDK.

    If the user provided invalid credentials, and it results in a non-recoverable error, then the onError method will be invoked.

    Parameters

    Returns Promise<void>

  • This method is invoked when valid PIN credentials were provided and verified locally.

    The method is invoked after verifyPin has been invoked and PinUserVerificationHandler.verifyPin is invoked in the PinUserVerificationHandler of verifyPin and the provided PIN credentials are valid.

    This method can be used for instance to hide the UI used to ask for credentials to the user (some text fields to get PIN credentials) and then display some progress message indicating that the operation is ongoing.

    Note that invoking this method does not mean that the UAF operation completed successfully (this is notified through onSuccess methods once the FIDO UAF server validates the request generated with the credentials).

    Returns void

Generated using TypeDoc