Deployment Support

Synthetic Credential Vault securely stores credentials used in synthetic jobs. When you create a job with a synthetic script, you can add a credential, such as a username and password to log in to an application, and inject a reference to the stored credential into the script. When the job runs, the synthetic script uses that reference to retrieve the credentials stored in Synthetic Credential Vault.

How to Use Synthetic Credential Vault

  1. Go to Gear Icon > 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.
  5. The synthetic job runs and retrieves the credential value associated with the credential key. 

Add Synthetic Credentials

In Synthetic 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 synthetic scripts. 



  • 1-100 characters

  • Alphanumeric characters, hyphens, and underscores only

  • Keys must be unique per EUM account


  • 5000 characters

  • Any non-control, printable UTF-16 characters

Credential key name (used in synthetic scripts)

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 Gear Icon 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 Gear Icon 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. 


Use Credentials in a Synthetic Script

You can retrieve a credential value by inserting the corresponding credential key in a synthetic script. Credentials associated to 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. Locate the DOM element associated with your credential.

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

    Synthetic Script


User Permissions

In the Controller UI, you can configure roles, users, and groups with Account-level, read-only permission for Synthetic Credential Vault. See Roles and Permissions for more information. As an admin-level user, we recommend you add a read-only role for Synthetic Credential Vault and assign that role to multiple users and/or groups. 

To create a role in the Controller UI with read-only permission:

  1. In the Controller UI, go to the gear icon > Administration > Roles.
  2. Under Roles, click Create.
  3. Add a role name, such as "Synthetic Credential Vault (read-only)."
  4. Under Account, click Add+.
  5. Check the "View Synthetic Credential Vault" box.
  6. Under User and Groups within this Role, add users and/or groups.

The table below describes permission differences between admin and read-only users for using Synthetic Credential Vault.

User LevelPermission

Requires "Administration," "Agents," and "Getting Started Wizard" permissions to:

  • Manage all users
  • Add, edit, and delete credentials
  • View both keys and values of stored credentials
  • View users, timestamps, and associated applications
  • View keys of stored credentials
  • View users, timestamps, and associated applications