API Reference - Web

Constructor

Javascript

NPM

import WebSDK from ‘@loginid/sdk';
const l = new WebSDK(‘BASE_URL’, ‘CLIENT_ID’);

HTML

CDN

<!-- Import module from the JS SDK -->
<script src="./src/vendor/loginid.web.min.js"></script>
<script>
  const lid = new LoginID.web.default(
      "{BASE_URL}", "{CLIENT_ID}"
  );
  // ...
</script>

isFido2Supported

Check whether the device and browser the user is on supports FIDO2.

Arguments

Returns

Example

registerWithFido2

Sign up a user for FIDO authentication.

Arguments

Returns

Example

Errors

registerWithPassword

Creates a user account with a password (not recommended). If leveraging this method, users should be migrating to use a FIDO authenticator, then have their password revoked.

Arguments

Returns

Example

Errors

authenticateWithFido2

Authenticate a previously registered user through FIDO2.

Arguments

Returns

Example

Errors

authenticateWithPassword

Authenticate a previously registered user using username and password.

Arguments

Returns

Example

Errors

confirmTransaction

Confirm the transaction for which the tx_id was previously generated.

Arguments

Returns

Example

Errors

addFido2CredentialWithCode

Leverage an authorized code to add a FIDO2 credential.

Arguments

Returns

Example

Errors

Deprecated Methods

The Web SDK previously had the following methods:

• .register()
• .login()

The methods have been deprecated, as the type of authenticator being registered is now specified in the register and authenticate methods.