Configure BeyondTrust for the Real-Time Dashboard Integration


You must purchase this integration separately from your BeyondTrust software. For more information, contact BeyondTrust sales.

Several configuration changes are necessary on the Secure Remote Access Appliance to implement the Real-Time Dashboard. All of the steps in this section take place in the BeyondTrust /login administrative interface. Access your BeyondTrust interface by going to the hostname of your Secure Remote Access Appliance followed by /login (e.g.,

Verify That the API Is Enabled

Enable XML API

This integration requires the BeyondTrust XML API to be enabled. This feature is used by the BeyondTrust Middleware Engine to communicate with the BeyondTrust APIs.

Go to /login > Management > API Configuration and verify that Enable XML API is checked.


Create an API Service Account


  1. Go to Management > API Configuration and create a new API account.


API account settings needed for real-time dashboard integration

  1. Under Permissions, check Read Only to the Command API.
  1. For the Reporting API, check Allow Access to Support Session Reports and Recordings and Allow Access to Presentation Session Reports and Recordings.
  2. For the Real-Time State API, check Allow Access.
  3. Be sure to copy the values for both the OAuth Client ID and OAuth Client Secret for use in a later step.
  4. Click Add API Account to create the account.