How to Track API Key Secret Resets

This article describes the implementation of audit logging for API Key secret refreshes within the FORTH system. It is organized into the following sections:

• Overview
• Prerequisites
• How to Access
• How it Works
• Assistance

Overview

Integrations often break when an API key secret is reset without coordination. The FORTH CRM ensures every API secret refresh is documented in your audit trail. Users can now quickly identify the root cause of integration issues by seeing exactly which user performed a reset and when it occurred.

Prerequisites

• Super Admin user permissions.

How to Access

1. To view the generated logs, click the Admin tab and select System Log from the navigation bar.
   
2. To perform the reset action, click the Admin tab and select REST API from the navigation bar.

How it Works

The system now automatically generates a log entry every time you refresh an API Key secret.

Refresh API Key

1. On the REST API page, scroll down the page to the Issued Credentials table.

2. Locate the specific API Key and click the Reset Secret icon (see the red-highlighted area in the image below).

Note: The system generates a new security token immediately and simultaneously creates a permanent record in the System Activity Log.

Post-Secret Reset

1. To find these resent event, navigate to Admin tab > System Log, and use the Keywords filter to search for API (see top most highlight in the image below).
2. View the log entries and activity details in the table that will appear:
   • Created: Displays the date and time of the reset (MM/DD/YYYY HH:MM am/pm).
   • User: Displays the full name of the super admin who performed the action.
   • Activity: A description confirming the secret was refreshed, including the specific Key ID (ses the bottom-most highlight in the image below).
     

Assistance

For further assistance, please reach out to support@setforth.com.