ネイティブバイオメトリックは、iOSおよびAndroid用の安全な資格情報の保管庫です。資格情報はネイティブのKeychainまたはKeystoreに保存され、敏感な値が返される前にバイオメトリック認証を必要とすることができます。 これは、Ionic Identity Vaultの資格情報保管庫のフローに直接置き換えられます; アプリはタイムアウト、ライフサイクル、プライバシースクリーン、カスタムパスコードポリシーを制御します。
基本機能
「基本機能」のセクションsetCredentialsかつgetCredentials- 指定されたサーバーに対して、安全にクレデンシャルを保存および取得します。getSecureCredentials- ネイティブのバイオメトリックチェック後にクレデンシャルをのみ読み取ります。isCredentialsSavedかつdeleteCredentials- オンボーディング、ロック状態、ログアウトフローの構築isAvailableかつverifyIdentity- 認証の有無を確認し、必要なときにユーザーに求めます。
パブリック API
セクション "パブリック API"| メソッド | 説明 |
|---|---|
isAvailable | バイオメトリック認証ハードウェアの利用可能性を確認します。 |
addListener | アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。このリスナーは、バックグラウンド中にユーザーがバイオメトリックを登録/解除した場合に、バイオメトリックの可用性が変更されたことを検出するのに役立ちます。 |
verifyIdentity | ユーザーにバイオメトリックで認証するように促します。 |
getCredentials | 指定されたサーバーに対して保存されたクレデンシャルを取得します。 |
setCredentials | 指定されたサーバーに対してクレデンシャルを保存します。 |
deleteCredentials | 指定されたサーバーに対して保存されたクレデンシャルを削除します。 |
getSecureCredentials | 指定されたサーバーに対して保存されたクレデンシャルを取得し、バイオメトリック認証が必要です。クレデンシャルは、BIOMETRY_CURRENT_SETまたはBIOMETRY_ANYでアクセス制御を設定した場合にのみ取得できます。 |
isCredentialsSaved | 指定されたサーバーに対してクレデンシャルがすでに保存されているかどうかを確認します。 |
getPluginVersion | Get the native Capacitor plugin version. |
バイオメトリック プラグインのネイティブ バージョンを取得します。
参照値「参照値」のセクション biometricError 結果を処理する際に、これらの値を使用します。 authenticate.
バイオメトリクス認証エラー
セクション「バイオメトリクス認証エラー」| 値 | Code | プラットフォーム | 意味 |
|---|---|---|---|
UNKNOWN_ERROR | 0 | Android、iOS | 不明なエラーが発生しました。 |
BIOMETRICS_UNAVAILABLE | 1 | Android、iOS | バイオメトリクスは、ハードウェアが欠落または利用できないため利用できません。 |
USER_LOCKOUT | 2 | Android、iOS | ユーザーは、多数の失敗した試行後にロックアウトされました。 |
BIOMETRICS_NOT_ENROLLED | 3 | Android、iOS | このデバイスにバイオメトリック情報は登録されていません。 |
USER_TEMPORARY_LOCKOUT | 4 | Android | ユーザーは通常30秒間ロックアウトされます。 |
AUTHENTICATION_FAILED | 10 | Android、iOS | 認証に失敗しました。 |
APP_CANCEL | 11 | iOS | アプリが認証フローをキャンセルしました。 |
INVALID_CONTEXT | 12 | iOS | 認証コンテキストが無効です。 |
NOT_INTERACTIVE | 13 | iOS | 認証は非対話的でした。 |
PASSCODE_NOT_SET | 14 | Android、iOS | デバイスのパスコード、PIN、またはフォールバック認証情報が設定されていません。 |
SYSTEM_CANCEL | 15 | Android、iOS | システムが認証をキャンセルしたため、例えば画面ロック後など。 |
USER_CANCEL | 16 | Android、iOS | ユーザーが認証をキャンセルしました。 |
USER_FALLBACK | 17 | Android、iOS | ユーザーがフォールバック認証を選択しました。 |
ソース・オブ・トゥルース
「ソース・オブ・トゥルース」セクションこのリファレンスは src/definitions.ts 「 capacitor-native-biometric.
Keep going from @capgo/capacitor-native-biometric
Section titled “Keep going from @capgo/capacitor-native-biometric”Capgoを使用している場合 @capgo/capacitor-native-biometric 認証とアカウントフローの計画に使用する@Capgo/Capgo-native-biometric Using @capgo/capacitor-native-biometric for the native capability in Using @capgo/capacitor-native-biometric, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, 2要素認証 2要素認証の実装詳細については、 SSO (エンタープライズ) SSO (エンタープライズ)の実装詳細については、