An interface that provides information about the information that is stored locally in the SDK. This includes authenticator and device information. The interface also allows to delete the data locally.

Hierarchy

  • LocalData

Methods

  • Convenience method that returns all the registered accounts.

    Returns Promise<Account[]>

    all the registered accounts.

  • Returns information about the authenticators. This information can be used for instance to know whether there is a registered authenticator or not, and thus if the user must register an authenticator or if authentication is possible.

    Returns Promise<Authenticator[]>

    all the authenticators.

  • Deletes all the data managed by the SDK regarding the provided authenticator.

    If the authenticator is registered, it will delete the associated FIDO UAF credentials of the provided user. If the authenticator is managed by the SDK (PIN or password authenticator), and the specified user is the only registered user, it will also delete the PIN or password definition (i.e. the authenticator will no longer be enrolled). f the username is not specified the authenticator deletion will be performed for all user.

    NOTE
    This method will only delete data locally. The FIDO UAF credentials will not be deleted from the server. This method should only be used when going through the protocol to delete authenticator information is not possible. For instance when the PIN authenticator is locked, which may be due to a security attack, and then it is desirable to delete the credentials locally. Using the Deregistration operation is the recommended way of deleting the FIDO UAF credentials.

    NOTE
    If no AAID is provided then all authenticators will be deleted.

    Parameters

    • username: string

      the username whose authenticator must be deleted.

    • Optional aaid: string

      the AAID of the Authenticator whose data must be deleted.

    Returns Promise<void>

Generated using TypeDoc