PublicKeyCredential: isUserVerifyingPlatformAuthenticatorAvailable() 静的メソッド

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2021年9月以降、すべてのブラウザーで利用可能です。

もっと詳しく
完全な互換性情報を見る

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

isUserVerifyingPlatformAuthenticatorAvailable() は PublicKeyCredential インターフェイスの静的メソッドで、ユーザー検証プラットフォーム認証機能が利用できる場合に true に解決される Promise を返すメソッドです。

ユーザー検証プラットフォーム認証機能は、クライアント端末の一部であり（一般に取り外し不可）、ユーザーを識別するためにユーザーの操作を必要とする多要素認証機能の一種です。一般的なユーザー検証プラットフォーム認証機能には、以下のものがあります。

Touch ID または Face ID (macOS や iOS)
Windows Hello (Windows)
Android の端末アンロック（指紋認証、顔認証、PIN、など）

メモ: このメソッドは最上位のコンテキストでのみ使用することができます。例えば <iframe> では使用できません。

構文

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()

SecurityError DOMException: RP のドメインが有効ではありません。

例

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()
  .then((available) => {
    if (available) {
      // この認証器で PublicKeyCredential の作成が可能
    } else {
      // 別の種類の認証器を使用するか、従来のログイン／パスワードによる認証手順を使用する
    }
  })
  .catch((err) => {
    // 何か問題が発生した
    console.error(err);
  });