Skip to content
English
Sign in
  • There are no suggestions because the search field is empty.

How to Renew the Secret Key for the Orchestry API

In this article, learn how to replace expired or expiring keys for the Orchestry API

The 'Client Secret' key first generated by Orchestry after the initial setup expires after about two years.  Admins can replace that key either before or after it officially expires.

Global admin or Entra Admin access is required to complete the steps below.

Want to learn about updating the secret key for the Orchestry Apps?
Check out the article: How to Renew the Secret Key for Orchestry Apps

 

How to Renew the Client Secret Key for the Orchestry API

  1. Navigate to the 'Connections' page in Orchestry.
  2. Click MANAGE APP.  This will launch Entra ID.

    KB-API-secretkey-01-2
  3. On the 'Client Secrets' tab (Manage > Client Secrets), click NEW CLIENT SECRET.
  4. Add a DESCRIPTION and EXPIRATION DATE for the new key.
  5. Click ADD to save and publish the new key.  Orchestry will automatically detect the new key.

    KB-API-secretkey-02

  6. Update any custom workflows that used the old key.

 

Make sure to update any custom workflows before deleting the old key from Entra.  Deleting the old key is NOT required for the new one to work.