[test.guide] Warning about expiring authentication keys

[test.guide] Warning about expiring authentication keys

Issue

I am receiving emails telling me that my authentication key or the authentication key of a technical user is expiring soon. Why? And what should I do?

Solution

Why am I getting this email?

Authentication keys for the test.guide REST API are only valid for a certain time period. This email alerts you that an authentication key is expiring, so you can change it in time.

You will get email notifications if one of your own authentication keys expires. When your email address was entered for a technical user or if you are a project manager you will also get email notification if the authentication keys of the technical user expire.

What should I do now?

If you get a notification please use the link in the message text to check the authentication keys. The email also includes the name of the key to identify it.

  • If the key was never used (i.e. if "Last used in days" contains a dash) you can simply ignore the notification or remove the key to avoid further notification

  • If the key was used before (i.e. if "Last used in days" contains a  number)

    • Create a new authentication key (using the respective button above the table)

    • Replace the old key with the newly created key in all of your API clients, resource adapters, tool configurations, etc.

      • The authentication key has a prefix, it can help you find and identify it within your scripts (older, migrated authentication keys do not have a prefix)

    • Afterward you can remove the old key to avoid further notification

If you use an authentication key in your scripts and are unsure to which technical user it belongs, you can use the /whoami endpoint in the User Management API to identify the user.

I have never created an authentication key in test.guide. Why do I still have a key named "Migrated Authentication Key"/"Migrated Legacy Authentication Key"?

In the past, each user in test.guide automatically had two authentication keys assigned to their account. The names of those keys are starting with "Migrated". If you have never used them (check "Last used in days" information), you can simply delete them without concern.