API Keys can be generated, removed, or refreshed by an Admin user in the Integrations Tab in the Employee Learning Cloud. When you navigate to the Settings tab and select Integrations, you will see an option for API. This page will only be accessible by ELC Admins.
While the API Keys can only be generated by an Internal Admin, these keys can be used for both the Employee Learning Cloud and the Customer Learning Cloud.
From there, you will be taken to the API Key management page where you can generate your first API Key. When you generate a new API Key, you will be prompted to select an Owner and a Description. Any Admin user can own an API Key, but you can select yourself, another admin, or “integration user” account to more easily maintain integrations. The description field allows you to describe how this will be used, so you have a record of where your keys are used.
Once you click “Generate,” a modal will pop up with your API key. Once you dismiss this modal, you will not be able to copy or view the key in WorkRamp again, so make sure to copy the key and use if before dismissing this modal.
Once you have one or more keys created, you will see the record of your keys in the table on this page. You will be able to see the last 4 digits of your key, the description, the owner, and last edited information for each key. From this page, you can also rotate the key (regenerate), edit the description, or delete the key.
Any time an API key is created, rotated, or deleted, the owner of that key will receive an email letting them know an API key they own has been generated or updated with a link to view the API key page in the Admin Console.
FAQ
Can I create more than one API token using the same Admin user profile?
Yes, you can generate different API tokens using the same Admin user profile.
Why do my keys not have a Last Updated Date?
Any keys that were generated before Admin Key Management was accessible in the Integrations tab does not have a last updated date associated with it.
Once you update a key or generate a new one, it will show in the Last Updated Date field.
Is there a limit on how many API keys an Admin can generate?
There is currently no limit.
Do these keys also work for setting up an integration for our Academies?
Yes, you will need to generate the key from your internal integration settings.