Hyperscience SaaS uses an authentication scheme that requires a client ID and password to authenticate and send API requests. Client IDs and passwords can be obtained on the API Accounts tab in the Users section of the platform.
Our API documentation outlines the steps required to connect to your Hyperscience SaaS environment via API.
Managing API accounts
If you have System Admin permissions, you can create and delete API accounts in the application. You can also create new passwords for API Accounts you've already created.
Creating a new API Account
You can create API Accounts for users in a particular permission group. After you've created the account, you will need to distribute the credentials to the users in the permission group you selected during the account-creation process. Hyperscience does not provide tools to share these credentials with your users.
To learn more about permission groups, see the “Permission Groups” article for your version of Hyperscience ( v35 | v36 | v37 | v38 | v39 | v40 ).
To create a new API account:
Go to Users > API Accounts, and click Create Account.
In the dialog box that appears, select the permission group you're creating an API Account for.
In the Description field, enter a description for the API Account.
Click Create Account.
Copy the client ID and account password. You will not be able to access the account password after you close the dialog box.
After you've copied the login credentials, click Close.
The API Account appears in the list of accounts on the API Accounts page.
Distribute the credentials to the permission group's users (e.g., through your organization's password-management system).
Resetting an API Account's password
If you're concerned that someone may have unauthorized access to an API Account, or if an account's password has been lost, you can reset the password for the account.
When you create a new password, the system will disable the current password. You will need to distribute the new password to the users in the account's permission group, just as you did when you first created the account. The account's client ID will remain the same.
To generate a new password:
Go to Users > API Accounts, and find the account whose password you want to reset.
In the account's row in the table, click the Generate New Password icon (
).In the dialog box that appears, click Generate New Password.
Copy the account password from the dialog box that appears. You will not be able to access the account password after you close the dialog box.
Click Close.
Distribute the new account password to the permission group's users (e.g., through your organization's password-management system).
Deleting an API Account
If you no longer need an API Account, you can delete it. Deleting the account invalidates its client ID and account password. Unless another API Account has been created for them, the users in the account's permission group will not be able to access the API.
To delete an API Account:
Go to Users > API Accounts, and find the account whose password you want to reset.
In the account's row in the table, click the Delete Account icon (
).In the dialog box that appears, click Delete Account.
The system deletes the account and removes it from the API Accounts page.