GetCredential

Gets a specified credential asset by using a provided Asset Name. If the credential asset is not global, it must be assigned to the local robot in order to be retrieved.

Definition

Namespace: UiPath.Activities.System.API

Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)

Overloads

GetCredential(String)	Gets a specified Orchestrator credential by using a provided AssetName, and returns a secure password. For more information about credential assets, see About Assets.
GetCredential(String, SecureString)	Gets a specified Orchestrator credential by using a provided AssetName and username, and a secure password. For more information about credential assets, see About Assets.
GetCredential(String, String)	Gets a specified Orchestrator credential by using a provided AssetName and folder path, and returns a secure password. For more information about credential assets, see About Assets.
GetCredential(String, SecureString, String)	Gets a specified Orchestrator credential by using a provided AssetName, username and folder path, and returns a secure password. For more information about credential assets, see About Assets.
GetCredential(String, String, SecureString, CacheStrategyEnum, Int32)	Gets a specified Orchestrator credential by using a provided AssetName, username, folder path, and cache strategy, and returns a secure password. For more information about credential assets, see About Assets.

GetCredential(String)

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

string GetCredential(
	string assetName
)

assetName String

The name of the asset for which to retrieve credentials.

GetCredential(String, SecureString)

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

string GetCredential(
	string assetName,
	out SecureString password
)

assetName String

The name of the asset for which to retrieve credentials.

password SecureString

Reference to the username of the retrieved credential.

GetCredential(String, String)

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

string GetCredential(
	string assetName,
	string folderPath
)

assetName String

The name of the asset for which to retrieve credentials.

folderPath String

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".

GetCredential(String, SecureString, String)

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

string GetCredential(
	string assetName,
	out SecureString password,
	string folderPath
)

assetName String

The name of the asset for which to retrieve credentials.

password SecureString

Reference to the username of the retrieved credential.

folderPath String

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".

GetCredential(String, String, SecureString, CacheStrategyEnum, Int32)

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

string GetCredential(
	string assetName,
	string folderPath,
	out SecureString password,
	CacheStrategyEnum cacheStrategy,
	int timeoutMS
)

assetName String

The name of the asset for which to retrieve credentials.

folderPath String

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".

password SecureString

Reference to the username of the retrieved credential.

cacheStrategy CacheStrategyEnum

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.

timeoutMS Int32

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).

Return value

String

The secure password of the retrieved credential.