Generate a new secret value

Last updated: Nov 20, 2024

DEVELOPER

HEALTH TECH VENDOR

This article is for legacy users since legacy API keys have been deprecated. Learn how to use OAuth keys, which are our preferred authentication method.

If you lose or expose the secret value of a legacy API key, follow the steps below to generate a new one.

Only for engineer roles

Any user in a given environment may view connectivity settings, including sources, destinations, API keys, and authentication credentials. However, you must be assigned to an engineer role to manage them (i.e., create, verify, edit, or delete). Learn about roles.

This how-to is only for users with an engineer role.

Log in to the Redox dashboard.
From the navigation menu, click the Developer page.
All of your configured API keys display on the page. For the API key whose key and secret you need to replace, click the Edit button.
The Settings tab displays for the selected API key. In the Secret field, click the New Secret button.
A confirmation modal appears. Click the Yes, change it button to generate a new random API secret value. The previous secret immediately stops working as soon as the new secret is generated to replace it. Otherwise, click the No, not yet button to cancel.
Generate a new secret value
The new secret value displays. Click the Copy button to copy the new secret value, then store the value securely.
New secret value
Copy your secret value first
Your new secret value only displays once, so be sure to copy the new secret before you exit the modal.
Even clicking outside the modal dismisses the New Secret modal, so copy the secret value before clicking anywhere else on the screen.

How to authenticate

In case you need a refresher, check out how to authenticate these types of API keys:

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.