How to cycle your key
How to rotate your api key with the /api/rotateKeys endpoint
If the api key has expired, please create an ES ticket to get it reinstated
Prerequisites
Tools needed
Postman Postman: The World's Leading API Platform | Sign Up for Free
A secure place to keep your credentials
Values Needed
Your Credentials
KeyId
(Basic Auth Password)ApiKey
(Basic Auth KeyId)
The
domain
url associated with the Environment you are working in.
Environment | AWS Instance | Domain |
---|---|---|
PROD | PROD | |
UAT/SUPPORT/QA | OPS | ops-all-integrationsauth-apikeys-v1.learningbuilder-api-ops.net |
Internal Note |
Download the Postman Files and Import them into your Postman
Collection
Environment
Rotating your key
1 | Configure Postman Environment | Inside of Postman Environment open the
|
2 | Save your Environment |
|
3 | Configure/Check |
|
4 | Send the request
|
Note, there is a script that will update your credentials in postman. This will allow you to easily just run in the next time. |
5 | Save your credentials somewhere secure | Your |
Troubleshooting
Did you save your environment? it is easy to forgo this step. As anyone whom has worked with Postman has probably forgotten this critical step before.
Ensure there are no spaces in your environment variables
Make sure the url is the correct one
Did you accidentally swap your KeyId and ApiKey?