Getting Here

Settings > User Management > API Keys

---

User Management - API Keys

The API Keys page under User Management allows you to view, manage, and create API keys for system integrations, access control, and automation.

---

Getting Here

Navigate to:
Settings > User Management > API Keys

---

Page Overview

Top Action Buttons

1. ADD API KEY

   • Description: Initiates the creation of a new API key.
   • Behavior: Opens a form to define API key details, including roles and permissions.

2. API SHARED SECRET

   • Description: Allows retrieval or creation of a shared secret for API integrations.

---

API Keys Table

The table provides an overview of all API keys and their details. The table contains the following columns:

---

Example Table Output

---

Table Features

1. Name / Desc

   • Displays the API key name, with a description or usage notes.

2. Role

   • Defines access permissions:
     • ADMIN: Full administrative privileges.
     • READONLY: Limited to read-only actions.

3. Last Login

   • Shows the most recent date and time the API key was used.
   • If the key has not been used, Never is displayed.

---

Actions

• Add API Key: Use this to create and configure new API keys.
• View Shared Secret: Access or configure the shared API secret.

---

Notes

• Regularly review API keys to ensure unused keys are deleted and active keys have appropriate roles.
• API keys with ADMIN permissions should be used cautiously to prevent unintended access.
• Monitor the Last Login column to identify and clean up inactive or unused API keys.

---

The API Keys Page enables secure and efficient management of API credentials, providing clear visibility into roles, usage, and access control.