Enumeration: VaultErrorCodes
The meaning of the error code in the thrown VaultError.
Enumeration Members
AndroidBiometricsLockedOut
• AndroidBiometricsLockedOut = 17
Biometrics have been locked out, usually because of too many failed attempts.
Note: This error will never be thrown if using DeviceSecurityType.SystemPasscode or DeviceSecurityType.Both. Its currently not possible to get the nature of failures from the native authentication dialog, so the only error that would be thrown is VaultErrorCodes.UserCanceledInteraction as the user is forced to cancel the prompt.
Constant
17
AndroidSystemPasscodeUnavailable
• AndroidSystemPasscodeUnavailable = 16
DeviceSecurityType.SystemPasscode for DeviceSecurityType not available on this Android device.
Constant
16
AndroidUnexpectedKeystoreError
• AndroidUnexpectedKeystoreError = 19
An unexpected error has occurred in the Android keystore. Some android devices (such as the Samsung S10) will return this error code when a maximum number of failed attempts is reached and the device must be restarted. See: Max Uses Per Boot
Constant
19
AuthFailed
• AuthFailed = 6
User authentication failed. This can occur when the user has denied use of biometrics or force closed the app during a biometric prompt. You can call the Device.isBiometricsAllowed method to determine if the user has denied access to Biometrics.
Constant
6
BiometricsNotEnabled
• BiometricsNotEnabled = 13
The operation failed because biometric authentication is not enabled. This can occur when biometrics is not supported by the device or when biometrics has not been configured for the device or vault.
Constant
13
InvalidArguments
• InvalidArguments = 3
The operation failed because the some of the vault provided arguments were invalid.
Constant
3
InvalidatedCredential
• InvalidatedCredential = 4
The credentials were invalidated. This can happen when a user changes biometrics or passcode. For Vaults with the DeviceSecurityType of Both if the biometrics change the vault will be invalidated on iOS but will not be on Android.
Constant
4
KeyNotFound
• KeyNotFound = 12
The key was not found. This can happen when a user changes biometrics or passcode.
Constant
12
MismatchedPasscode
• MismatchedPasscode = 9
The user provided mismatched passcodes.
Constant
9
MissingBiometrics
• MissingBiometrics = 15
Biometrics have not been authed yet (Android only)
Constant
15
MissingPasscode
• MissingPasscode = 10
The operation requires passcode to be setup but it isn't set yet. Call Vault.setCustomPasscode to set it.
Constant
10
PasscodeNotEnabled
• PasscodeNotEnabled = 11
The operation failed because the application tried to unlock the vault with passcode authentication, but the vault is not configured to allow passcode authentication.
Constant
11
SecurityNotAvailable
• SecurityNotAvailable = 5
Biometric security is unavailable due to a passcode not being set up at the system level. In order to use biometric identification on the device a system level passcode must be set up by the user.
Constant
5
TooManyFailedAttempts
• TooManyFailedAttempts = 7
Too many failed authentication attempts made against the custom passcode vault, so the vault was cleared and user will need to login again.
Constant
7
Unknown
• Unknown = 0
An unknown error happened.
Constant
0
UserCanceledInteraction
• UserCanceledInteraction = 8
The user cancelled the native authentication dialog.
Note: On iOS, this error code will also be thrown in the event that the native authentication dialog fails as a result of too many failed attempts. The user will be forced to cancel the dialog, triggering this error code.
On Android, this error also will be thrown if using DeviceSecurityType.SystemPasscode or DeviceSecurityType.Both in the event of too many failed attempts. Its currently not possible to get the nature of failures from the native authentication dialog, and similar to iOS, the user will be forced to cancel the dialog, triggering this error code.
Constant
8
VaultLocked
• VaultLocked = 1
The operation failed because the vault was locked.
Constant
1
VaultUnavailable
• VaultUnavailable = 2
The operation failed because the vault was unavailable. The most likely cause of this error is that a vault has not been configured.
Constant
2
iOSBiometricsLockedOut
• iOSBiometricsLockedOut = 18
Biometrics have been locked out, usually because of too many failed attempts.
Constant
18