Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Using the Credential Manager utility to store API keys

Updated on October 19, 2022

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.

You must store locally at least one API Group to integrate with BeyondTrust. When the API keys in BeyondTrust have the User password required option set to Yes, then you must also store Runas users and passwords locally.

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.Note: The Credential Manager (CredMgrUI.exe) utility is located in the install folder for the RPA Service.

  1. Go to the RPA Service installation folder.
  2. Start the CredMgrUI.exe program with administrator rights.
    Pega RPA Service Credential Manager
    Examples of the RPA Service Credential Manager windows for API Group and Runas User.
  3. In the Credential field, choose the type of credentials that you want to add.
    Credential typeDescription
    RegistrationOperatorChoose 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.
    WindowsUserChoose 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.
    RuntimeUserChoose 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 UserChoose 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.
  4. 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.
  5. 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.
  6. 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.
  7. 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.
  8. When finished, click Add.

  • Previous topic Configuring the CredentialManagerConfig.xml file for BeyondTrust
  • Next topic Using Pega Access to control integration behavior

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us