Setting up Postman to Query Your Reliability Data

This article shows how to set up Postman with an authentication token that allows users access to your AssetWise Reliability (APM) data.

Tip:       Download the Postman desktop app from Postman.com. There is also a web app for Postman.

The procedure explains how to configure the token whether you are using client or user credentials. The steps involved are:

• Start a new collection. Collections let you group related requests, making them easier to access and run. Every request (query) in the collection will use the same authorization
• Add client or user credentials, most of which are provided to you by Bentley. Client credentials are used for jobs that run without user interaction and are managed by Bentley Support Services. We recommend using user credentials so that users are prompted to enter their passwords in the browser. For example: 

• Generate the authorization token and create the collection

Note:  The authorization must be renewed every hour because the Access token has a 60-minute expiration period.

Note:  Be sure to adhere to Postman recommendations regarding sensitive data.

To set up Postman

1. Open Postman and click Create a collection. Collections let you group related requests, making them easier to access and run.

The Create a New Collection window opens:

2. Enter a name (for example, “Bentley Reliability API”) and description. 

3. Select the Authorization tab. In the Type list select “OAuth 2.0”. Authentication is performed with Bentley Identification Management System (IMS) using OpenID Connect/OAuth 2.0.

The window changes accordingly.

4. Scroll down on the right side and configure the new token with either client or user credentials.

For user credentials, enter:

• Token name – For example, “Bentley Token”
• Grant type – Select “Authorization Code (With PKCE)”
• Callback URL – Select "Authorize using browser". The read-only callback URL is filled in automatically
• Auth URL – enter the URL supplied by Bentley
• Access Token URL – enter the URL supplied by Bentley
• Client ID – Enter the client ID supplied by Bentley
• Scope – Enter the scope supplied by Bentley
• Client Authentication – Select “Send as Basic Auth header”

For client credentials, enter:

• Token name – For example, “Bentley Token”
• Grant type – select “Client Credentials”
• Access Token URL – enter the URL supplied by Bentley
• Client ID – Enter the client ID supplied by Bentley
• Client Secret – Copy in the secret supplied by Bentley
• Scope – Enter the scope supplied by Bentley
• Client Authentication – Select “Send client credentials in body”

5. Click Get New Access Token. When the token is created, click Use Token.

6. Click Create. You have now created a collection in Postman.

Define a Tenant ID for your Collection

We recommend defining a variable for the GUID of the tenant ID. You can enter the TenantID GUID once and then reuse it everywhere in the collection. Be sure to use descriptive variable names if you wish to use two or more IDs. For example:

For more information, see the Postman article Store and reuse values using variables.