Skip to main content

How do I create, view, change and revoke API Keys?

How to create, view, change and revoke API Keys.

Andy Scott avatar
Written by Andy Scott
Updated over a month ago

Using the Operata integration and API access requires the generation of an API Key, which is done within the Operata user interface, here's how...


Creating an API Key

  • Login as an admin user and navigate to the Group Settings/Integrations section.

  • Select the API Management section.

  • From here you can create a new API Key by entering a name in the API Key Name field and then selecting + Create New Key

Creating dedicated API Keys for each function and including AWS_Integration and Contact_Lens_Integration in the API Key names, will ease support issues going forward.

  • Use the Copy function to copy the API Key - this is the only time you will see the API Key.


Change API Keys

  • It is not possible to change an active API Key, simply create a new API Key and update the Operata elements using it, before using Delete icon to delete the old one.

  • For AWS Integration and Contact Lens integration the API Key is stored in AWS Secrets Manager - details of how to update this are below.


Revoking API Keys

  • Select the Delete icon and then OK at the confirmation step, to remove the API Key.

Did this answer your question?