Create a client application

An OAuth 2.0 client application is a set of credentials for one system that needs access to one of the HP Insights APIs. Create one client application for each API an integration uses, and revoke it when the integration is retired.

Before you start, have the following ready

  • The name of the system or tool you're connecting.
  • Which API it needs to access. See Available APIs.
  • Whether it needs read-only or full access.

Create the application

1

Open the Create Application form

Go to Analysis > API > Client Application. The Create Application form appears at the top of the page.

2

Enter an application name

Use a descriptive name that identifies the integration's purpose, for example Okta-SCIM-Production or PowerBI-Meter-Reporting. Avoid generic names like Test or API1, which are hard to tell apart when you have several integrations.

3

Select the API

Choose the API this application will access from the API drop-down. Each client application can access only one API. The options are:

  • Billing Accounts
  • SCIM v2.0
  • Device API
  • Document Management
  • Device Scout API
  • Print Scout API

For what each API does and a link to its documentation, see Available APIs.

4

Select the permission level

Choose from the Access drop-down:

  • Full: the application can read and write data. Use this only when the integration needs to create, update or delete records, for example to provision users with SCIM.
  • Read Only: the application can retrieve data but can't change it. Use this for reporting tools, dashboards and any integration that only reads data.

Grant the least access the integration needs. If it only reads data, choose Read Only, even if you trust the system. This limits the impact if the credentials are ever exposed.

5

Create the application and save the credentials

Select Create. HP Insights generates a Client ID and Client Secret and shows them on screen.

Note: The Client Secret is shown only once and can't be retrieved later. Copy both values and store them in your secrets manager before you close the dialog. If you lose the secret, revoke the application and create a new one.

Result

The application appears as a card in the Client Application section. The card shows the application name, the API and its scopes, the issue date, a Revoke button and a link to the API documentation.

Use the credentials

Pass the Client ID and Client Secret to whoever is configuring the integration, such as a developer, a BI analyst or your identity provider administrator. They exchange them for an OAuth 2.0 access token, which is included in each API request to HP Insights. For implementation details, see the documentation linked on the application card.

Revoke a client application

Revoke a client application when the integration is retired, when the Client Secret may have been exposed, or when you rotate credentials as routine maintenance.

  1. In Analysis > API > Client Application, find the card for the application.
  2. Select Revoke on the card.
  3. Confirm when prompted.

Note: Revoking is immediate and can't be undone. Tokens issued under the revoked Client ID stop working straight away, and the integration fails until you create new credentials and update its configuration.

Related topics