Skip to main content
Version: 6.0

Interface: IdentityVaultConfig

Properties​

androidBiometricsNegativeButtonText​

• Optional androidBiometricsNegativeButtonText: string

  • Type: string

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

Default

"Cancel"

androidBiometricsPreferStrongVaultOrSystemPasscode​

• Optional androidBiometricsPreferStrongVaultOrSystemPasscode: AndroidBiometricCryptoPreference

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


_10
{@link AndroidBiometricCryptoPreference.StrongVault}

androidBiometricsPromptDescription​

• Optional androidBiometricsPromptDescription: string

  • Type: string

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

Default

null

androidBiometricsPromptSubtitle​

• Optional androidBiometricsPromptSubtitle: string

  • Type: string

For Android, the subtitle text for the authentication prompt.

Default

null

androidBiometricsPromptTitle​

• Optional androidBiometricsPromptTitle: string

  • Type: string

For Android, the title text for the authentication prompt.

Default

"Please Authenticate"

customPasscodeInvalidUnlockAttempts​

• Optional customPasscodeInvalidUnlockAttempts: number

  • 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​

• Optional deviceSecurityType: 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


_10
{@link DeviceSecurityType.None}

iosBiometricsLocalizedCancelTitle​

• Optional iosBiometricsLocalizedCancelTitle: string

  • 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


_10
'null`

iosBiometricsLocalizedFallbackTitle​

• Optional iosBiometricsLocalizedFallbackTitle: string

  • 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​

• Optional iosBiometricsLocalizedReason: string

  • Type: string

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

Default

null

key​

• key: string

  • 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​

• Optional lockAfterBackgrounded: number

  • Type: number

Lock the vault when the app is resumed if it has been in the background for this number of milliseconds.

Default

null

shouldClearVaultAfterTooManyFailedAttempts​

• Optional shouldClearVaultAfterTooManyFailedAttempts: boolean

  • Type: boolean

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

Only supported on CustomPasscode vaults.

Default

false

type​

• type: VaultType

The type of vault.

unlockVaultOnLoad​

• Optional unlockVaultOnLoad: boolean

  • Type: boolean

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

Default

false

Contents