Using the Credential Manager utility to store API keys
Store the API Groups (API keys) and Runas users that are required for retrieving
credentials from BeyondTrust by using the RPA
Service Credential Manager (CredMgrUI.exe
) utility. These
shared secrets are stored in an encrypted file named RpaStartup.info
in
the C:\ProgramData\Pegasystems
folder.
The
CredMgrUI.exe
utility has two special credential types
available when the Credential provider is set to BeyondTrust in the
CommonConfig.xml
file. The special types are:
- BeyondTrust API group
- BeyondTrust Runas user
The RPA Service Credential Manager utility allows you to input
credentials for the RegistrationOperator,
WindowsUser, and RuntimeUser keys.
The number of API Group and Runas user entries that are required is determined by
your entries in the CredentialManagerConfig.xml
file.CredMgrUI.exe
) utility is located in the install folder
for the RPA Service.
- Go to the RPA Service installation folder.
- Start the
CredMgrUI.exe
program with administrator rights.Pega RPA Service Credential Manager - In the Credential field, choose the type of credentials
that you want to add.
Credential type Description RegistrationOperator Choose this credential type to define a reserved name that is used by the RPA Service and Robot Runtime. For more information, see Understanding how Robot Runtime retrieves credentials from BeyondTrust. WindowsUser Choose this credential type if you want to set up the credentials that the robot uses to log in to Microsoft Windows. For more information, see Understanding how Robot Runtime retrieves credentials from BeyondTrust. RuntimeUser Choose this credential type to define a reserved name that is used by the RPA Service. For more information, see Understanding how Robot Runtime retrieves credentials from BeyondTrust. Beyond Trust API Group Choose this credential type if you are using Beyond Trust as a credential provider and the request uses the API key from the API group.
API credentials are unique identifiers that are added to ensure that API calls in the automation are secure.
Beyond Trust Runas User Choose this credential type if you are using Beyond Trust as a credential provider and the credential is requested for a Runas user. Setting up a Runas user enables you to start the robot on a computer or virtual machine as a different user. - In the Domain field, enter the domain that the user should be logged into. If you do not specify a domain, the system uses the local machine name.
- The next two fields differ, depending on your choice in the
Credential field.
- If you chose Beyond Trust API Group, enter the API Group and API Key.
- If you chose Beyond Trust Runas User, enter the Runas user name and password.
- In the Workgroup field, enter the work group that this
entry corresponds to. To add multiple work groups, enter a comma-delimited list,
such as
“Workgroup1, Workgroup2”
. If you do not specify a work group, the system uses the credentials that you enter as the default if it cannot find the work group specified by Robot Manager.Note: Unattended RPA allows for a unique domain and Runas user name/password for each work group that the robot can work in. Use this setting to specify different credentials for each work group. - If you are setting up robots to be used with the Server Bot Framework, use the Robot Index field to indicate which robots these credentials are for. For more information, see Server Bot Framework.
- When finished, click Add.
- Using Pega Access to control integration behavior
Use Pega Access to limit the amount of information that you store locally.
Previous topic Configuring the CredentialManagerConfig.xml file for BeyondTrust Next topic Using Pega Access to control integration behavior