Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

If the api key has expired, please create an ES ticket to get it reinstated

Prerequisites

Tools needed

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

prd-integrationsauth-apikeys-v1.learningbuilder-api.com

UAT/SUPPORT/QA

OPS

ops-all-integrationsauth-apikeys-v1.learningbuilder-api-ops.net

(warning) Internal Note INT/LAB/TEST are only active if necessary and are not maintained

Download the Postman Files and Import them into your Postman

  • Collection

    View file
    nameSelf Rotate Key.postman_collection.json

  • Environment

    View file
    nameSelf Rotate Key.postman_environment.json

Rotating your key

  1. Go to your environments and open the Self Rotate Key Environment

    1. Update the domain Current Value to the Domain Should be one listed above

    2. Update basicAuthUserName_KeyId Current Value equals your current KeyId

    3. Update basicAuthPassword_ApiKey Current Value equals your current ApiKey

  2. (warning) Save your Environment

  3. Go to your collections and open the Self Rotate Key Collection

  4. Open the Self rotate request

  5. Confirm your variables (optional)

    1. Hover over the domain, ensure the correct variable

    2. Go to the Authorization tab, ensure the Auth Type is basic

      1. Hover over basicAuthUserName_KeyId ensure the Username is your KeyId

      2. Hover over basicAuthPassword_ApiKey ensure the Password is you ApiKey

  6. Once you have filled your environment variable go ahead and click “Send”. This will create a Post call that updates your credentials.

  7. In the Response body will be your Updated credentials.

    1. Result looks like this image-20241115-230620.png

    2. Note, there is a script that will update your credentials in postman.

  8. Save this in a secure location.

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?

...