--- title: "$SecureCredentialProperty" ---
This is generated from the built in components of BuildMaster 2023.0, and may be different than what you have installed (especially if you have extensions); go to [Gear Icon] -> Administration -> Functions within your BuildMaster instance to see exactly what operations are available.

the decrypted plain text value of a specified credentials property

Script usage:

$SecureCredentialProperty(credential, property)

Parameters:

NameDescription
credentialThe name of the credential to read.
propertyThe name of the credential property to get. If the property is encrypted, the credential itself must be configured to allow the value to be extracted, otherwise the function call will fail at run time.

Example:

# HDarsUser is a Username & Password Credentials with 'Allow encrypted properties...' checked

set $username = $SecureCredentialProperty(HDarsUser, Username);
set $password = $SecureCredentialProperty(HDarsUser, Password);

Log-Debug Executing sometool.exe -user $username -pass *****;
Exec sometool.exe -user $username -pass $password;