Generating a JWT token

Edit online

Generate a JWT token to access the IBM® ESG Suite APIs.

Before you begin

You must be assigned the API token role. For more information, see Assigning an API token role.

About this task

The JWT token is supplied as the bearer token as part of the API authentication process. API client tools might have different ways for supplying the JWT token for authentication.

Note: If you can no longer find your JWT token, you can generate a new one. However, the new token automatically invalidates the previous token.

Procedure

  1. Click the profile icon on the menu bar, and click My API Access Token to open the Access Tokens grid.
  2. Click Create New.
  3. Assign a token name. The name must be unique.
  4. Set the number of days that the token is valid for in the Expire on field. Select from:
    • 1 day
    • 7 days
    • 30 days
    • 60 days
    • 1 Year
    • Never
  5. Set the scope of the token. Select the API endpoints that the token will apply to.
    Select Meta Record to include calls to the /meta endpoint in the token. Select Report Record to include calls to the /data endpoint.
    Note: It is recommended that you select both API endpoints.
  6. Click Save.
    The token is added to the Access Tokens grid.
  7. Click Actions and select Generate Token from the menu.
    The Generate Token confirmation dialog is displayed with the token and expiry date.
  8. Copy the full content of the JWT token.
    Important: Copy and securely store the JWT token somewhere. It is no longer visible to you from the platform when the token is saved.
  9. Click Save.
    The name and scope of the token is sent to you by email, but not the JWT token or expiry date.

Results

The status of the token updates to Generated - Inactive. Later, when you use the token, it updates to Generated - Active.

What to do next

For more information about using the JWT token to authenticate API calls, see Accessing APIs.