Skip to main content

Creating an API client for the TPRM Core integration

Create the service account API client that lets TPRM Core connect to your Hyperproof organization.

Roles and permissions

  • Only administrators can create an API client for the TPRM Core integration

Note: This feature is not enabled by default. Contact your Customer Success Manager or Account Manager to learn more.

TPRM Core connects to Hyperproof through a service account API client. When you mark a service account API client for the TPRM integration, Hyperproof assigns the role and scopes the integration needs, so you don't have to choose them. If the integration later requires additional access, Hyperproof automatically updates the existing API client.

The API client is assigned the API admin role and the following access:

  • Read and update - Controls, issues, the organization, proof, questionnaires, risks, tasks, and vendors

  • Read-only - Custom fields, external contacts, groups, risk registers, and users

This access applies whether or not your organization uses each of these modules.

Creating an API client for the TPRM Core integration

  1. From the left menu, select Settings.

  2. Select API clients.

  3. Select the Service account tab, and then click New.

    The New API client window opens.

  4. Below Name, enter a name for the API client, such as TPRM Core. Names must be unique among service account API clients in your organization.

  5. Below Client ID, click the Copy to clipboard icon and store the client ID securely.

  6. Select Use this service account for the TPRM integration.

    The Scopes and Role fields are hidden.

  7. In Client secret, click the Copy to clipboard icon and store the client secret securely.

    Note: Client secrets cannot be viewed again once the New API client window is closed.

  8. Optionally, change the secret's Description and Expiration date. By default, the client secret expires 6 months after it's created.

  9. Click Save.

    The API client is created.

  10. In TPRM Core, enter the client ID and client secret. [verify: TPRM Core navigation path and field labels, or link to the TPRM Core article]

Note: When the client secret expires, TPRM Core can no longer connect to Hyperproof. Add a new secret and update it in TPRM Core before the current one expires. See Managing API clients.

Editing the TPRM Core API client

After the API client is created, you can rename it, add or delete secrets, change secret expiration dates, or delete the API client. See Managing API clients.

You can't change its scopes or role, and you can't clear Use this service account for the TPRM integration. To use a different setup, delete the API client and create a new one.

Did this answer your question?