Managing Environments

Vault Toolbox connects to Vault through saved environments. Environments are named connections to a Vault DNS, each with its own authentication method. You can save multiple environments and connect to more than one at a time, with one marked as active at any moment.

This guide explains how to add, connect to, and manage environments.

Authentication Methods

Section link for Authentication Methods

When you add an environment, you can select from one of the following authentication methods:

• Basic (User Name/Password): Prompts for your username and password.
• Session ID: Prompts for an active Vault session ID.
• API Access Token: Prompts for a Vault API access token.

Adding an Environment

Section link for Adding an Environment

To add an environment:

1. Select the Vault Toolbox icon in the lefthand panel.
2. Select the Environments () tab.
3. Click Add Environment.
4. Enter a Vault DNS, for example myvault.veevavault.com.
5. Optional: Enter a Label to distinguish this environment. If left blank, Vault Toolbox adopts the connected Vault's own name on first connect.
6. Select an Authentication Method (Basic, Session ID, or API Access Token) and provide the corresponding credentials.
   
7. Click Add.

Once successfully added, a card for the new environment appears under the list of All Environments.

Connecting to an Environment

Section link for Connecting to an Environment

In the Environments tab, click on an environment's card to connect to it, or to disconnect. You can connect to more than one environment at a time, although only one can be active at any moment.

The environment you're actively working with is marked ACTIVE. The active, connected environment is pinned in a Current Environment section at the top of the list. Every other environment, connected or not, appears under All Environments. Click on a connected environment to make it active.

Note

A status bar entry always shows the active environment's label, with a PROD suffix when it's connected to a production Vault. Click it to reveal the Environments tab.

Expand Vault Info on a connected environment's card to view the details of that Vault, including a link that opens the Vault DNS in your browser.

Editing or Removing an Environment

Section link for Editing or Removing an Environment

Click on an environment's card to change its Vault DNS, label, authentication method, or credentials. Leave the credential field blank to keep the existing one.

Click to remove an environment. This also removes its saved credentials.

Working with Production Vaults

Section link for Working with Production Vaults

Vault Toolbox labels a connected environment with PROD when it detects a production Vault. Actions that write to Vault, such as deploying or dropping MDL, deploying or deleting Vault Java SDK code, and applying changes from comparing environments, are blocked on a production Vault.