Credential Vault for Web Monitoring

Deployment Support

How to Use Credential Vault

1. Go to  > Tools > Manage Synthetic Credentials. 

2. Add a credential in a key-value pair to Synthetic Credential Vault. 

3. Create a synthetic job using a synthetic script. 

4. Inject the credential key into the synthetic script.

   

   The job runs and retrieves the credential value associated with the credential key.

5. The synthetic job runs and retrieves the credential value associated with the credential key. 

Add Synthetic Credentials

In Credential Vault, you can add credentials one-by-one or import multiple credentials.

Syntax Rules

This table describes credential syntax rules used for creating credentials and adding credentials to the synthetic scripts:

"<%key%>"

Add a Single Credential

If you want to use a combination of credentials, such as a username and password combination, you must create two separate credentials: one credential for the username and one for the password.

To add a single credential for a sample email:

1. Go to  > Tools > Manage Synthetic Credentials.

2. Click Add. 

3. Enter a key and value. Make sure you follow syntax rules. 

4. (Optional) Select an associated application. When you search for credentials in the synthetic script, associated credentials are suggested first. 
   

Import Multiple Credentials

You can add multiple credentials at once using the Import button.

To add multiple credentials for sample emails and passwords:

1. Go to  > Tools > Manage Synthetic Credentials.

2. Click Import.

3. Copy and paste credentials or type them line by line. Make sure you follow syntax rules. 

• The maximum number of credentials that can be imported at once is 250.
• You cannot add associated applications to imported credentials. After importing, you must edit each credential individually to add the associated application. 

email_key=user123@email.com
password_key=Password123
email_key=user456@email.com
password_key=Password456

Use Credentials in a Synthetic Script

You can retrieve a credential value by inserting the corresponding credential key in a script. Credentials associated with a specific application appear first when you start typing the key in the script.

To create a synthetic job:

1. Go to User Experience > Jobs > Add. 
2. Add your synthetic script. See Write Your First Script.

3. Enter the credential key using the syntax "<%key%>".

   Synthetic Script

   driver.find_element_by_id("email").send_keys("<%email_key%>")
   driver.find_element_by_id("pass").send_keys("<%password_key%>")

   CODE

User Permissions

In the Controller Administration UI, you can configure roles and groups with Account-level. You can add roles and groups to users based on the requirement. The Manage Credential Vault permission allows you to manage access control of the Credential Vault.

After upgrading to 23.8, the Manage Credential Vault permission gets added automatically to all the roles with existing Administration, Agents, Getting Started Wizard permission. This process takes approximately five hours to complete.

If you do not want the administrator users to access the Credential Vault, remove the Manage Credential Vault permission for those users.

Before Upgrading to 23.8	After Upgrading to 23.8
Administration, Agents, Getting Started Wizard permission has the following privileges: Manage all users Add, edit, and delete credentials View both keys and values of stored credentials View users, timestamps, and associated applications columns	Manage Credential Vault permission gets automatically added to all the roles with existing Administration, Agents, Getting Started Wizard permission. This permission has the following privileges: Manage all users Add, edit, and delete credentials View both keys and values of stored credentials View users, timestamps, and associated applications columns From 23.8 onwards, when you assign a user with the Administration, Agents, Getting Started Wizard permission, the user does not have access to the Credential Vault by default.
View Credential Vault permission has the following privileges: View keys of stored credentials View users, timestamps, and associated applications columns	View Credential Vault permission has the following privileges: View keys of stored credentials View users and timestamps columns

To create a role with the Manage Credential Vault:

1. Go to  > Administration > Roles.
2. Under Roles, click Create.
3. Add a role name.
4. Under Account, click Add+.
5. Select one of the following permissions based on the role that you are creating:
   • Manage Credential Vault
   • View Credential Vault
6. Under User and Groups with this Role, add users and/or groups.