Using the Smooth Reset Secret feature for authorized applications

Resetting credentials can cause disruptions if the old credentials are immediately revoked. The Smooth Reset feature reduces this risk by allowing the old credentials to remain active for a specified period.

Example scenario: A company's application must update its credentials regularly for security reasons. Without a smooth reset, the application might experience downtime while new credentials propagate. With Smooth Reset enabled, the old credentials remain active for up to seven days, allowing the application to continue running while new credentials are configured.

  1. Navigate to OS > API Gateway > Authorized Apps.
  2. Select the authorized app and click Reset Secret.
  3. In the Reset Secret dialog box, turn on the Smooth Rollover toggle.
    When the Smooth Rollover toggle is enabled, a text box appears for setting the old secret retention period.
  4. Specify a value between 1 and 7 days.
    This period defines how long the previous credentials remain valid after new credentials are issued.
  5. If the old secret is no longer in use, click Revoke Old Secret to invalidate the old credentials before the retention period ends.

Smooth Reset includes validation checks and permission requirements. Use these troubleshooting tips to resolve common issues:

Invalid retention period
The retention period field accepts only values between 1 and 7 days. Enter a whole number within this range. The system prompts for correction if an invalid value is entered.
Smooth Reset toggle not visible
The Smooth Reset feature is available only to IONAPI-Admin users. Ensure that you have the required permissions. Contact your system administrator if the toggle remains hidden.
Old credentials not revoked
If previous credentials remain active beyond the retention period, check for system delays or errors. Manually revoke the old credentials if needed.
UI validation errors
Validation errors can occur when entering values in the retention period field. Enter numeric values within the valid range and follow on-screen prompts to resolve the issue.