PublicKeyCredential: isConditionalMediationAvailable() statische Methode

Baseline 2023
Newly available

Since October 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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

Die statische Methode isConditionalMediationAvailable() der PublicKeyCredential-Schnittstelle gibt ein Promise zurück, das auf true aufgelöst wird, wenn bedingte Vermittlung verfügbar ist.

Syntax

js
PublicKeyCredential.isConditionalMediationAvailable()

Parameter

Keine.

Rückgabewert

Ein Promise, das zu einem Booleschen Wert aufgelöst wird, der angibt, ob bedingte Vermittlung verfügbar ist oder nicht.

Ausnahmen

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

SecurityError DOMException

Die RP-Domain ist ungültig.

Beispiele

Bevor Sie einen bedingten WebAuthn-API-Aufruf tätigen, prüfen Sie, ob:

  • Der Browser die Web Authentication API unterstützt.
  • Der Browser die WebAuthn-bedingte UI unterstützt.
js
// Availability of `window.PublicKeyCredential` means WebAuthn is usable.
if (
  window.PublicKeyCredential &&
  PublicKeyCredential.isConditionalMediationAvailable
) {
  // Check if conditional mediation is available.
  const isCMA = await PublicKeyCredential.isConditionalMediationAvailable();
  if (isCMA) {
    // Call WebAuthn authentication
    const publicKeyCredentialRequestOptions = {
      // Server generated challenge
      challenge: challengeFromServer,
      // The same RP ID as used during registration
      rpId: "example.com",
    };

    const credential = await navigator.credentials.get({
      publicKey: publicKeyCredentialRequestOptions,
      signal: abortController.signal,
      // Specify 'conditional' to activate conditional UI
      mediation: "conditional",
    });
  }
}

Hinweis: Weitere Informationen zur Verwendung von bedingter Vermittlung finden Sie unter Mit einem Passkey über die automatische Formularausfüllung anmelden.

Spezifikationen

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

Browser-Kompatibilität