Get Credential / Get Orchestrator Credential

UiPath.Core.Activities.GetRobotCredential

Description

Gets a specified Orchestrator credential by using a provided AssetName, and returns a username and a secure password. For more information about credential assets, see About Assets.

The activity uses the same authentication context as the Robot under which it runs.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Windows, Cross-platform configuration

• Orchestrator folder path - The path of the folder where the credential is located and must be retrieved from, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".
• Asset Name - The name of the asset for which to retrieve credentials.
  • If you click on the Manage assets button next to Asset Name, you are taken to the Assets section in the Orchestrator to which Studio is connected.

Additional options

Misc

• Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
• CacheStrategy - Specifies the period of time retrieved values are cached. By default, all requests are forwarded to Orchestrator. The available options are None and Execution. Choosing Execution caches the Orchestrator Asset and uses it for the whole process execution.

Output

• Username - Reference to the username of the retrieved credential.
• Password - Reference to the secure password of the retrieved credential.

Windows - Legacy configuration

Properties panel

Common

• DisplayName - The display name of the activity.
• Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Input

• AssetName - The name of the credential to be retrieved.
• CacheStrategy - Specifies the period of time retrieved values are cached. By default, all requests are forwarded to Orchestrator. The available options are None, Execution, and 24Hours.

Misc

• OrchestratorFolderPath - The path of the folder where the credential asset is stored and must be retrieved from, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".
• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• Username - Reference to the username of the retrieved credential.

• Password - Reference to the secure password of the retrieved credential.

  Note:

  The FolderPath parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.

  Relative folder paths are supported in an X-UIPATH-FolderPath-Encoded header, as follows:

  -right: Path starting with / - starts from the root folder of the tree the ambient folder is part of.

  -right: Path starting with . - starts from the ambient folder.

  -right: Path starting with .. - starts one level up in the hierarchy of the ambient folder for each .. in the path (e.g. ../ for one level up, ../../ for two levels up in the hierarchy).

  Note that trailing slashes are not accepted.