Geneious Biologics allows users to create API keys that can then be used to set up automations that interact with our Public REST API. This is particularly useful if you have Single Sign On enforced. Keys can be created by existing users, or you may like to create a dedicated user to act as a service account, allowing you to clearly manage the data access permissions.
Note: API key creation needs to be enabled by an "admin" user in your organisation. If you would like to turn on API keys for your organisation, please contact us.
API Keys are advanced functionality. If you are unsure whether you need to use one, please ask your IT team or contact us.
Creating an API Key
When API keys are enabled for your organisation, any user may choose to create an API key. To do so, navigate to you user account page. This can be found via the person icon in the far right hand corner.
Your user account page contains your basic details, and is the best place to change your name or password. To create a new API key, simply click create as indicated below. If you can't see the API key section, this means that API keys are not turned on for your organisation.
Specifying the name simply helps you manage your keys, you might like to include a date or purpose.
Your full API key will only be available to view once, so please save this in a safe place, such as a suitable Password Management tool.
Viewing and Managing your API Keys
If you have any API keys, they can be seen in the User Account page as above. You can see the last time that each key was used to sign in.
If you would like to remove an API key, simply click "Revoke". The API key will be deactivated and removed immediately. It will not show up in your API Key table anymore.
Managing your Organisation's API Keys (Admin)
Admin users can see a list of all currently active API keys for their organisation. The API Key table can be found by navigating to the User table and then click the "Show API Keys" button as indicated below.
The API Keys table allows you to see when each key was last used and who owns it. You can also revoke any user's API key here, including your own.
You can also click on a user's name in the Users table to see more detailed account information, including any current API keys they might own.