What is a Vault?

Vault is a simple way to store sensitive and/or important information, share it with the team and use it within the Flows.

Vault enables you securely store:

1.Sensitive information like API Keys, Application Tokens, etc.

2.Values that don't change that often are used in multiple Actions/Flows. For example, contact email, phone number, or address.

In this article, we'll learn:

What is a Vault?
How to create a Vault?
How to Edit & Delete a Vault?
How to use Vaults within Flows?

1.What is a Vault?

Vault is secure and double-encrypted storage specific to a Workspace. You can use Vault to store sensitive data like API keys, passwords, OAUTH2 credentials, access tokens, etc. in your Workspace and share the Vault item, not the value, with the members of your Workspace.

You can use the Vault item in your Flows. Using a Vault item as a secure constant to store values that don't change often, enables you to create a more robust solution. For example, if you store your company's support email address in the Vault and use the Vault item in multiple Flows, if and when that address changes, you only need to update the Vault item and would not need to change each and every Flow.

You can find the Vaults section in the Settings of your Workspace: to add, edit, delete, and list all the vaults available in the system.

2.How to create a new Vault?

Adding a new vault is straightforward. Just click on the New button on the Vault page. It will give you two options to start with. You can create a Secret or OAuth2 Credential by selecting the preferred option.

Secrets

Secrets can be created by clicking on the Secret option and it will give you the Create secret dialogue to add a name, description, and secret value. Furthermore, the secret’s privacy can be set to Shared or Private using the Privacy toggle.

OAuth2 Credential

Similarly, if you select the OAuth2 Credential option, the Create OAuth 2 credential dialogue will be popped up as follows.

As you have seen in the secret creation dialogue, you can add general information such as name, description, and privacy. Other than that, the OAuth2 Settings tab can be used to define the relevant endpoints, client id, secret, and scopes as shown in the following.

3.How to Edit & Delete a Vault

The existing vaults can be edited or deleted by first selecting the vault and then clicking on the Edit Vault or Delete Vault buttons located at the top right corner of the Vault page.

In addition, you can use the Update Configuration button to edit the OAuth2 credential settings. Furthermore, if you have selected the OAuth2 credential type vault, the Authorize OAuth Credential button can be used to authorize the given endpoint as follows:

4.How to use Vaults within the Flows?

Up To now, the guide has explained the Zenphi vaults and the manipulation of vaults. In this piece, you will get to know how to consume the created Vaults in your Zenphi Flow. The Vault values are accessible through the Token picker to your Flow actions as shown in the following image:

Let's say you have an Assign Task action in your Flow, and you want to add a Supplier Email as an assignee. Then, you need to click on the Token Picker, open the Vaults section and choose a needed value.

As you can see, once you've added the Vault, the value itself isn't shown, only its title, which is very convenient for sensitive data.

To summarize, Zenphi Vaults hold sensitive information like authorization credentials, passwords, and secrets. The vaults can be managed through the Vault page of Zenphi. The existing vaults are accessible through the Token Picker to Flow actions.