API Access

On the API Access page, you can automatically generate a username and password, which you can later use to configure the OData Feed Connection for the Reporting Power BI template.

The username and password are automatically generated by the system and cannot be changed.

Generate the API Access Password

To generate a password for API access:

1. Navigate to Manage > System > API Access. 

2. Click Create in the table toolbar.

3. In the Create client secret window:

  • Enter a description.
  • Specify an Expiration date. By default, the field is pre-filled with a date two years from the current date. If left blank, the expiration will be set to 'Never'.

4. Click Finish on the Summary tab to generate the client secret.

The Your client secret has been created message that appears contains the password for the Power BI OData Feed Connection.

One-Time Display of Client Secret

Once your client secret is generated, copy and store it safely, as this is displayed only once and cannot be accessed again.

Find Your API Access Username

Your PowerBI OData Feed Connection username becomes available after the client secret is created. You'll need to open the newly created client secret to view it.

NOTE: The username is a static value, unique per zone.

API-Access-PowerBI-template.png

View Client Secrets List

The API Access page lists all the client secrets currently available in the Application Workspace System.

By default, your client secrets appear in alphabetic order, with the following details: Secret Hint, Description, Expiration date and Expired.

TIP: You can create your own personalized view of the table by filtering the client secrets or adding/deleting columns and clicking Save as in the Views drop-down menu.

Selecting multiple table rows

  • Adjacent rows: Click on the first row, hold down the Shift key, click on the last row in the range
  • Non-adjacent rows: Hold the Ctrl or Cmd key and click on each row you want to select
  • Adjacent rows, using only the mouse: Click and hold the left mouse button on the first row, then drag the cursor up or down across the rows to highlight the desired ones