Skip to main content
Version: 5.0

Installation

Don't have an Identity Vault subscription? Try it free now.

Follow these steps to install Identity Vault into your app.

Installation#

If you have not already setup Ionic Enterprise in your app, follow the one-time setup steps.

Next, install the plugin:

npm install @ionic-enterprise/identity-vaultnpx cap sync

Update the native project config files:

// iOS - Info.plist<key>NSFaceIDUsageDescription</key><string>Use Face ID to authenticate yourself and login</string>
// Android - No additional changes needed

Identity Vault 5 and later requires Android SDK 30+. This is configured in the build.gradle file for Capacitor or by using Cordova-Android 10 or later. Capacitor 2 and above is supported. If using Capacitor 3, ensure Capacitor dependencies are >=3.0.2.

Configuring the Vault#

Identity Vault is created in your application by instantiating a new instance of the Vault class and passing a configuration object to it.

const vault = new Vault({  key: 'io.ionic.identityvaultdemo',});

Once the vault is created, you can call the various methods on it including lock and unlock to secure the vault and setValue and getValue to manage data in the vault.

await vault.unlock();await vault.getValue('myKey');await vault.setValue('myKey', 'newValue!');await vault.lock();