Help Centre › Credentials & Connections
This article describes the RPA Vault functionality to retrieve a stored credential.
For a full list of available functions, please read VAULT functions.
Description
The Retrieve credential function retrieves a stored credential from the vault by name. You can retrieve all fields as an object, or a specific field such as password or token.
Setting it up
To use the Retrieve credential function, follow these instructions:
{{popups:rpas/add:action=vault-get}}
Once on a process map:
- Navigate to the process where you would like to add the Retrieve credential function
- Click on the green button’s drop-down (right side of the green button labelled “Process”)
- On the menu that appears, click on the “+ Activity” item
- From here you can select the VAULT Retrieve credential option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Name | Yes | Text | - | The name of the credential to retrieve |
| Field | No | Text | - | Specific field to retrieve (e.g. password, token). Omit to get all fields. |
| Variable | No | Text | credential | Variable name to store the result |
Output variables
| Variable | Type | Description |
|---|---|---|
| {credential} | String or Object | The credential value. Returns a string if a specific field is requested, or an object with all fields if no field is specified. |
Errors
| Error | Description |
|---|---|
| Credential not found | No credential exists with the specified name |
| Decryption failed | The credential could not be decrypted, possibly due to a corrupted key |
Tips
- Use the field parameter to get just the password or token instead of the full credential object
- Omit the field parameter to retrieve all fields as an object