Roles and permissions
All users can create and manage their own personal API clients
Only administrators can create and manage service account API clients
Note: If you don't see API clients in the Settings menu, contact your Customer Success Manager or Account Manager. [verify: is API clients enabled by default?]
An API client lets an external application, script, or integration connect to the Hyperproof API using a client ID and client secret. API clients are managed from Settings > API clients, which has the following tabs:
Personal - API clients that act with your own Hyperproof role. You can only see the personal API clients you created.
Service account - API clients that act as a dedicated service account with its own role, independent of any user. Visible to administrators only.
To create an API client, see Enabling M2M API authentication. To create the API client that connects Hyperproof to TPRM Core, see Creating an API client for the TPRM Core integration.
Note: Some service account API clients are managed by Hyperproof. Their Edit and Delete actions are unavailable.
Editing an API client
From the left menu, select Settings.
Select API clients.
Select the Personal or Service account tab.
In the row for the API client, click Edit.
The Edit API client window opens.
Update the name, scopes, role (service account API clients only), or secrets as needed.
For each secret, you can change the Description and Expiration date, click Delete to remove it, or click New secret to add another one. An API client must have at least one secret.
Click Save.
Note: Existing secret values are hidden. A secret's value can only be copied right after you create it, before you save and close the window.
Rotating a client secret
Because an API client can have more than one secret, you can replace a secret without interrupting the integration that uses it.
From the left menu, select Settings.
Select API clients.
Select the Personal or Service account tab.
In the row for the API client, click Edit.
The Edit API client window opens.
Click New secret, then click the Copy to clipboard icon next to the new client secret and store it securely.
Click Save.
Update your integration to use the new secret.
Edit the API client again, click Delete next to the old secret, and then click Save.
Deleting an API client
From the left menu, select Settings.
Select API clients.
Select the Personal or Service account tab.
In the row for the API client, click Delete.
The Delete API client window opens.
Click Delete.
Note: Any integration that uses the deleted API client can no longer connect to Hyperproof. Deleting a service account API client also deactivates its service account.