Skip to main content
Version: 5.0.0-beta

IdentityVaultConfig

Properties#

androidBiometricsNegativeButtonText#

  • Type: string

For Android, the text of the button to dismiss the biometric prompt.

Default#

"Cancel"

androidBiometricsPreferStrongVaultOrSystemPasscode#

For Android, when VaultType is VaultType.DeviceSecurity and DeviceSecurityType is DeviceSecurityType.Both, this options specifies if you want to prefer a Strong Cryptographic Vault or the System Passcode fallback when they both aren't available.

Default#

AndroidBiometricCryptoPreference.StrongVault

androidBiometricsPromptDescription#

  • Type: string

For Android, the description text for the Android authentication prompt.

Default#

null

androidBiometricsPromptSubtitle#

  • Type: string

For Android, the subtitle text for the authentication prompt.

Default#

null

androidBiometricsPromptTitle#

  • Type: string

For Android, the title text for the authentication prompt.

Default#

"Please Authenticate"

customPasscodeInvalidUnlockAttempts#

  • Type: number

When type is set to CustomPasscode, this controls how many failed unlock attempts are allowed if shouldClearVaultAfterTooManyFailedAttempts is enabled. Having this many failed attempts will clear the vault.

Default#

5

deviceSecurityType#

When type is set to DeviceSecurity, determines which aspects of the device to use to secure the vault. Note: Android only supports SystemPasscode on Android 11 and greater.

Default#

DeviceSecurityType.Both

iosBiometricsLocalizedCancelTitle#

  • Type: string

For iOS, the localized title for the cancel button in the dialog presented to the user during authentication. If null, iOS will use an appropriate default value, like "Cancel".

Default#

'null`

iosBiometricsLocalizedFallbackTitle#

  • Type: string

For iOS, the localized title for the fallback button presented to the user during authentication. If null, iOS will use an appropriate default value, like "Use Passcode”.

Default#

null

iosBiometricsLocalizedReason#

  • Type: string

For iOS, the localized explanation for authentication shown in the dialog presented to the user.

Default#

null

key#

  • Type: string

The key that will be used to uniquely identify the vault in the app. If only one vault will be used, you can set it to something like the app identifier (com.mycompany.myapp). *

lockAfterBackgrounded#

  • Type: number

The number of milliseconds the app can be in the background until the vault locks

Default#

null

shouldClearVaultAfterTooManyFailedAttempts#

  • Type: boolean

If the app should clear the vault if too many invalid unlock attempts where made

Default#

false

type#

The type of vault.

unlockVaultOnLoad#

  • Type: boolean

When true, the vault will attempt to unlock when the app launches and resumes from being in the background.

Default#

false