Firefox Tomorrow

web api interface

OTPCredential

View on MDN ↗

Secure contextLimited availability

The OTPCredential interface of the WebOTP API is returned when a WebOTP navigator.credentials.get() call (i.e., invoked with an otp option) fulfills. It includes a code property that contains the retrieved one-time password (OTP).

Instance properties

This interface also inherits properties from Credential.

  • code Read only Experimental
    • : The one-time password (OTP).

Instance methods

None.

Examples

The below code triggers the browser’s permission flow when an SMS message arrives. If permission is granted, then the promise resolves with an OTPCredential object. The contained code value is then set as the value of an <input> form element, which is then submitted.

navigator.credentials
  .get({
    otp: { transport: ["sms"] },
    signal: ac.signal,
  })
  .then((otp) => {
    input.value = otp.code;
    if (form) form.submit();
  })
  .catch((err) => {
    console.error(err);
  });

[!NOTE] For a full explanation of the code, see the WebOTP API landing page. You can also see this code as part of a full working demo.

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.