Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. Go to Develop > Services > Security Click Configure > SECURITY > Vault. 
  2. Click Create NewVault.
  3. Type Enter the name and description of the new Vault in the Name and Description fields respectively.

    Image Added

  4. Enter the Vault Alias other than the default name.
    You can change Vault Alias before you

    hit Save. Once

    you save it. Once saved, you cannot modify the field.

    Info
    Vault Alias is a unique field. It holds the parameters which in turn are used to save the confidential information.


  5. Type in a key and its value.
  6. Click Add to add a new Parameter.
  7. Click Image Added to view the hidden values. Click Image Added to mask the password. To delete a parameter, click Image Added in front of it.
  8. Expand Advanced Properties to change the project and owner of this vault. Also provide/update permission of Read, Write, or Execute to Owner, Group, and Others. Click here for more information on how permissions work.
  9. Click Save.

...

titleUsing Vault

...

  1. Expand Advanced Properties and select the Project from drop-down list of Project.
  2. 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