PublicKeyCredential: isUserVerifyingPlatformAuthenticatorAvailable() statische Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die isUserVerifyingPlatformAuthenticatorAvailable() statische Methode der PublicKeyCredential-Schnittstelle gibt ein Promise zurück, das zu true aufgelöst wird, wenn ein benutzerverifizierender Plattform-Authenticator vorhanden ist.

Ein benutzerverifizierender Plattform-Authenticator ist eine Art von Multi-Faktor-Authenticator, der Teil des Client-Geräts ist (er ist in der Regel nicht entfernbar) und bei dem eine Aktion des Benutzers erforderlich ist, um ihn zu identifizieren. Zu den üblichen benutzerverifizierenden Plattform-Authenticatoren gehören:

  • Touch ID oder Face ID (macOS und iOS)
  • Windows Hello (Windows)
  • Gerätesperre (Fingerabdruck, Gesicht, PIN, etc.) auf Android

Hinweis: Diese Methode kann nur in Top-Level-Kontexten verwendet werden und steht beispielsweise in einem <iframe> nicht zur Verfügung.

Syntax

js
PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()

Parameter

Keine.

Rückgabewert

Ein Promise, das zu einem booleschen Wert aufgelöst wird, der angibt, ob ein benutzerverifizierender Plattform-Authenticator verfügbar ist oder nicht.

Hinweis: In früheren Versionen der Spezifikation wurde mit dem booleschen Wert auch die Zustimmung des Benutzers zur Offenlegung eines solchen Authenticators vermittelt.

Ausnahmen

Das zurückgegebene Promise kann mit den folgenden Werten abgelehnt werden:

SecurityError DOMException

Die RP-Domain ist nicht gültig.

Beispiele

js
PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()
  .then((available) => {
    if (available) {
      // We can proceed with the creation of a PublicKeyCredential
      // with this authenticator
    } else {
      // Use another kind of authenticator or a classical login/password
      // workflow
    }
  })
  .catch((err) => {
    // Something went wrong
    console.error(err);
  });

Spezifikationen

Specification
Web Authentication: An API for accessing Public Key Credentials - Level 3
# dom-publickeycredential-isuserverifyingplatformauthenticatoravailable

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch