ネイティブバイオメトリックは、iOSおよびAndroid用の安全な認証情報の保管庫です。ネイティブのキーチェーンまたはキーストアに認証情報を保存し、敏感な値が返される前にバイオメトリック認証を要求できます。Ionic Identity Vault認証情報の保管庫のフローに直接置き換えます。アプリはタイムアウト、ライフサイクル、プライバシースクリーン、カスタムパスコードポリシーを制御します。
主な機能
「主な機能」セクションsetCredentialsJapanesegetCredentials/ja/docs/plugins/native-biometric/getSecureCredentialsCloudflareisCredentialsSavedCapacitordeleteCredentialsGitHubisAvailableCapgoverifyIdentitycode
Public API
Section titled “Public API”| CLI | npm |
|---|---|
isAvailable | bun |
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.
capgoから続けて@capacitor-native-biometric
「capgoから続けて@capacitor-native-biometric」Capgoを使用している場合 @capgo/capacitor-native-biometric @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometricを使用して Capgoを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-native-biometricを接続してください @capgo/capacitor-native-biometricを使用して Capgoを使用して@capgo/capacitor-native-biometricのネイティブ機能を実装する場合 @capgo/capacitor-social-loginを使用して Capgoを使用して@capgo/capacitor-social-loginの実装詳細を実装する場合 @capgo/capacitor-passkeyを使用して 2要素認証 2要素認証の実装詳細については、 SSO (エンタープライズ) SSO (エンタープライズ)の実装詳細については、