If you need to create credentials that will be used by machines rather than humans (e.g., service accounts), you can create machine credentials, which the machines can use to authenticate into the Hyperscience application and API endpoints.
Create machine credentials
To add a set of machine credentials to your instance:
On the Machine Credentials page (Users > Machine Credentials), click Add Machine Credentials.
In the Add Machine Credentials dialog box, enter a description for the credentials, and click Next. This description will help you identify the set of credentials after it's created.
Select one of the following options, based on your organization's security policies:
Client Secret — When you select this option, the system will generate a secret key in the next step.
Public Key — Selecting this option allows you to provide a public key in JSON Web Key (JWK) format.
[v40.2 and later] Click on the Add Permission Groups drop-down list, and select the checkboxes for the permission group you'd like to assign to the credentials. When you're finished selecting permission groups, click Next.
The Add Machine Credentials dialog box shows the client ID and description of the credentials, along with a button to copy the secret key if the Client Secret option was selected in step 3.
Click the Copy button for Client ID to copy and paste the client ID in a secure file on your machine.
If you selected the Client Secret option in step 3, click the Copy button for Secret to copy and paste the secret key in a secure file on your machine. You will not have another opportunity to obtain the secret key. If you do not copy the secret key in this step, you will need to regenerate a secret key for the credentials.
Click Done.
The machine credentials appear in the Machine Credentials table and are ready to use.
Assign permission groups to existing machine credential
This feature is available in v40.2 and later.
You can assign permission groups to machine credentials, just as you would to a user account designed for human use. Doing so allows you to grant your machine credentials the exact set of permissions needed for your use case.
Before you begin…
Make sure you have permission groups that include the permissions you would like to grant to your machine credentials. To learn how to create and edit permission groups, see Managing Permission Groups.
While those permission groups can have authentication groups linked to them, we recommend that you do not link authentication groups to the permission groups you plan to assign to machine credentials.
On the Machine Credentials page (Users > Machine Credentials), click on the client ID of the machine credentials you want to assign permission groups to.
In the Edit Machine Credentials dialog box, click on the Add Permission Groups drop-down list, and select the checkboxes for the permission group you'd like to assign to the credentials.
Click Done.
Use a machine credential to access the Hyperscience API
After you've created machine credentials with API permissions, you can use them to access the Hyperscience API. For more information, contact your Hyperscience representative.
Edit the descriptions of machine credentials
You can edit the description of a set of machine credentials. To do so:
Click on its Client ID in the Machine Credentials table (Users > Machine Credentials).
In the Edit Machine Credentials dialog box, enter the updated description.
Click Done.
Reset a secret key
If you lost the secret key for a set of machine credentials, or if the key has been compromised, you can generate a new secret key. This option only applies to machine credentials that have a client ID.
To reset a secret key:
On the Machine Credentials page (Users > Machine Credentials), click on the client ID of the machine credentials whose secret key you'd like to reset.
In the Edit Machine Credentials dialog box, click Reset and Copy Secret.
In the confirmation dialog box, click Reset credentials.
The credentials are automatically copied to your clipboard. Paste them in a secure file on your machine.
You'll also need to replace the secret key In any code that uses the credentials to send API requests.
Deactivate machine credentials
If you no longer need a set of machine credentials, you can deactivate it. Deactivating credentials removes them from the Machine Credentials table.
Deactivate a single set of machine credentials
To deactivate a single set of credentials, click on its Client ID in the table on the Machine Credentials page (Users > Machine Credentials), and then click Deactivate Machine Credentials.
Deactivate multiple sets of machine credentials
To deactivate multiple sets of machine credentials:
Select their checkboxes in the table on the Machine Credentials page (Users > Machine Credentials).
Click Actions, and then click Deactivate User.
Reactivate machine credentials
If you need to use machine credentials that were deactivated (e.g., if they were deactivated by mistake), you can reactivate them.
To reactivate machine credentials:
On the Machine Credentials page (Users > Machine Credentials), click Show deactivated machine credentials >.
Select the checkboxes for the credentials you'd like to reactivate, and click Reactivate Machine Credentials.
The credentials appear in the Machine Credentials table and are ready for use.