Skip to end of metadata
Go to start of metadata

Path to function: Management > API keys

This page allows the creation and management of the keys you can use with the OpenAthens REST API, including the API connector for local authentication.

Create a new key

Click on the add button at the top of the page and enter a name that describes what you will be using it for:

A key will be generated on save.

Edit name

You can edit the name assigned to a key by hovering over the key and selecting the edit button that appears. You cannot change the key value or expiry date.

Deleting a key

Hover over the key you want to delete and select the remove button that appears.

Expiry dates

An expiry date is automatically generated. When it is nearing, the system will automatically send an email to the address on your account. The first email is 30 days before expiry and as the date approaches the system will email you more regularly. Just as with accounts, the key will not work on the expiry date. Emails are sent to the email address in the organisation account that created the key.

Anything to watch out for?

When a key expires or is disabled, any application using it will receive invalid credentials errors from the API. It will not be able to interact with OpenAthens until the key that system is using is updated with a valid one.

  • No labels