Using Named Passwords

A named password is a variable that users can use across a project's build job configurations. Named passwords can be used in any password field in the job configuration, such as external Git repositories, SQLcl, PSMcli, and Docker configurations.

When the password changes, change the value of the variable and the new password is applied to all jobs and configurations where the variable is used. Note that the named password is not an environment variable. To use a named password as an environment variable, create a Password build parameter and set it to use the named password.

Create a Named Password

You must be assigned the project Owner role to create a named password.

Action	How To
Create a named password	In the navigation bar, click Project Settings . Click Build. Expand Named Passwords. Click + Create. In the Create New Named Password dialog box, in Name, enter a name for the variable. In Password, enter the password. Click Create. After creating the named password, share its name with your project users.
Edit a named password	In the navigation bar, click Project Settings . Click Build. Expand Named Passwords. Click the password name and then click . In the Edit Named Password dialog box, update the password. You can't change the named password's name. Click Update.
Delete the named password	In the navigation bar, click Project Settings . Click Build. Expand Named Passwords. Click the named password name and then click . In the Delete Named Password dialog box, click Delete. After deleting the named password, let your project users know that it's no longer available.

Configure a Job to Use a Named Password

1. Open the job’s configuration page.
2. In the Password field of the component you want to configure, enter the named variable as #{password_name}.
   For example, if the name of the named password is my_password, enter #{my_password}.
3. Click Save.