Vault

Vault is a repository that keeps confidential information secured in the Database. Vault provides a robust security level, by adding more security while saving and accessing the classified data. Instead of storing information as a plain text, Vault is used to securely save and fetch data in an encrypted form. The services that use Vault includes Database Info, Custom Plugin, Web Service REST Consumer, and Put-Context-Var Action.

To create a Vault and define its custom keys to store and fetch the confidential information:

1. Click Configure > SECURITY > Vault.
2. Click Create Vault.
3. Enter the name and description of the new Vault in the Name and Description fields respectively.
   
   
   
   

4. Enter the Vault Alias other than the default name. If you leave this field blank, it will take the Vault name as an Alias.
   You can change Vault Alias before you save it. Once saved, you cannot modify the field.

   Vault Alias is a unique field. It holds the parameters which in turn are used to save the confidential information.
5. In Parameters section, Enter Key and its Value which you want to store in vault.
6. Click Add to add a new Parameter.
7. Click  to view the hidden values. Click  to mask the password. To delete a parameter, click  in front of it.
8. Select the project in the Project field.

9. Click Save.
   

After you have created a vault, replace the confidential information while using a service, with the text in the following syntax: {Vault.aliasName.key}

where,

• Vault is a keyword (V in 'Vault' is UPPERCASE), preceded by opening curly parentheses.
• aliasName is the Vault Alias, where the parameter is defined.
• key is the parameter which stores the confidential information.
• Finally closed by a closing curly parentheses.
• A period is used as a separator between Vault and aliasName; and aliasName and key.

You can use Vault to mask the confidential information instead of providing it as a plain text, in the following services:

• Database Info
• Custom Plugin
• Web Service REST Consumer
• Put-Context-Var Action