Get Vault Item
Verb: getVaultItem
Available from: <Standard>
Gets user password vault credentials.
Syntax
getVaultItem --name(String) [--system(Boolean)] (Boolean)=success (String)=userName (SecureString)=password
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --name | Name | Required | Text | Name of the credential in which the values are contained. |
| --system | System | Optional | Boolean | Refers to access to the systemic password vault. When enabled, information is sought from the systemic vault.
When this parameter is not enabled, credentials are fetched from the vault (password vault manager). |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| success | Success | Boolean | Returns "True", if the retrieval of information was unsuccessful, otherwise returns "False". |
| userName | User Name | Text | Username that is stored in the key. |
| password | Password | Secure String | Encrypted text with the password that is stored in the key.
The password is not displayed because of client/user security. |
Example
Uses the Get Vault Item command to get the encrypted credentials from the user vault.
defVar --name executionResult --type Boolean
defVar --name user --type String
defVar --name password --type SecureString
getVaultItem --name crmCredential --system password=password executionResult=success user=userName