Set up API access

Supported in versions: LoadRunner Enterprise 2021 R1 and later

API key authentication provides a secure authentication mechanism for external applications accessing LoadRunner Enterprise's API.

Overview

For applications to access LoadRunner Enterprise, you must grant them registered access keys. These applications use the access keys for authentication when communicating as clients with LoadRunner Enterprise. To use API access keys in LoadRunner Enterprise, SSO or LDAP authentication must be enabled on the LoadRunner Enterprise server.

Applications that need authentication include:

  • LoadRunner Enterprise's CI and Application Automation Tool plugins: Git, Bamboo, TeamCity, Jenkins, and Azure DevOps. For details, see Plugins.

  • Other third party applications and APIs that need to integrate with LoadRunner Enterprise, such as those that are located behind a firewall.

The LoadRunner Enterprise administrator generates and manages the list of API access keys for LoadRunner Enterprise.

  • Each API access key includes a Client ID and a Secret Code for applications to use when authenticating. The secret key is like a user password and should be recorded securely.

    Tip: LoadRunner Enterprise generates each secret key once only, and the secret key cannot be retrieved later. If a new secret key is needed, delete the access key, and then regenerate a new access key. For details, see Delete API access keys and Create API access keys.

  • Each API access key is associated with a LoadRunner Enterprise user. Therefore, when an application uses an API key to access LoadRunner Enterprise, the application is limited by its user's permissions.

  • You can use an API access key to access LoadRunner Enterprise only if it is currently listed as Active in the list of API keys.

Back to top

Create API access keys

To create an API access key and associate it with users, perform the following:

  1. Prerequisites.

    Make sure SSO or LDAP authentication is enabled on the LoadRunner Enterprise server. For details, see Select or change the authentication type.

  2. In LoadRunner Enterprise Administration, select Management > Users and click the Access Keys tab.

  3. On the Access Keys toolbar, click Add Access Key, and select a user to associate with the key (the users list displays users with Active status only).

    Note: An administrator can assign up to two keys per user.

  4. Click Generate Access Key. You receive a Client ID and Secret Code, which you need to provide to the person who needs to use this key for authentication.

  5. Click Copy to Clipboard to copy these keys to the clipboard so you can use them when configuring the applications that need to access LoadRunner Enterprise. The keys are copied in JSON format to the clipboard.

  6. Click Save. The access key is added to the grid. Note that its status is Active.

    The User Status column reflects the status (Active/Inactive) of the user associated with the API access key. When the User's Status is Inactive, the values displayed in the User Name and User Status columns are grayed out.

Back to top

Deactivate and reactivate API access keys

You can deactivate API access keys when you want to temporarily block API keys from accessing LoadRunner Enterprise.

  1. In LoadRunner Enterprise Administration, select Management > Users and click the Access Keys tab.

  2. Select the row of the access key you want to deactivate.

  3. Click Deactivate. The access key is immediately revoked and its status changes to Inactive.

    When you deactivate an access key, the user associated with the key is blocked from accessing the system with external applications using this deactivated key.

    To reactivate if necessary, select the row of the access key that was deactivated and click Activate. The access key is immediately restored and its status changes to Active.

Back to top

Delete API access keys

When you delete an API access key, the user associated with the key is blocked from accessing the system with external applications using this key.

  1. In LoadRunner Enterprise Administration, select Management > Users and click the Access Keys tab.

  2. Select the row of the access key to be deleted.

  3. Click Delete Access Key. The access key is deleted from the grid.

Note: If a user is deleted from LoadRunner Enterprise Administration, all the user's access keys are deleted automatically.

Back to top

Track API connections

You can track API connections to LoadRunner Enterprise in the Connection Audit page. For details, see Track user login and logout connections.

Back to top

See also: