API Keys Management User Guide

Overview

The API Keys Management module allows administrators to generate, manage, and revoke API keys used to integrate external applications with the platform.

API keys are used to:

• Authenticate system-to-system communication
• Enable secure automation
• Manage Issuing Authority user roles programmatically
• Control application-level access

⚠️ API Keys provide system access. Handle them securely.

API Keys Dashboard

The main dashboard includes:

• Global Search Bar
• Create New API Key button
• API Keys Table
• Filters and pagination controls

API Keys Table

Columns Overview

API Key

• Only the last 4 characters are visible
• Includes search functionality
• Full key is never displayed again after creation

Status

Filter options:

• All
• Enabled
• Disabled

Indicates whether the API key is currently active.

Created On

Date filter options:

• All dates
• Today
• Last 7 days
• Last 30 days
• Last year
• Custom date range

Displays when the API key was generated.

Expiration

Same date filter options as Created On.

Shows the configured expiration date of the API key.

Name / Description

Displays the purpose or remarks entered during key creation.

Example:

“Key for managing issuing authority user roles”

Raw Expires At

Displays the expiration date in raw system format (for technical reference).

Action - Delete

When clicked, a confirmation prompt appears:

"Are you sure you want to delete this API Key?"
"Deleting this key will revoke access to all applications using it. This action cannot be undone."

Options:

• Cancel
• Proceed to Delete

⚠️ Deleting an API key immediately revokes access for all applications using it.

Creating a New API Key

Click Create New API Key to generate a new key.

Purpose of Creation / Remarks

Enter a clear description of the key’s purpose.

Example:

• Key for managing issuing authority user roles
• Integration with internal HR system
• Automation for certificate issuance

This field will appear in the table under Name/Description.

Expiration

Select expiration period:

• No Expiration
• 7 days
• 30 days
• 90 days
• 6 months
• 1 year
• Custom date

If no expiration is selected, the key remains valid until manually deleted.

Important Notice

API Secret will be shown only once. Save it securely.

You will not be able to retrieve the secret again after closing the window.

Generate API Key

Click Generate API Key to create the credentials.

API Key Created Confirmation

Once generated, a confirmation screen will appear.

“You have successfully issued a certificate”

(Note: This message confirms successful API key generation.)

Your API Key

Example:

1234567890abcd

Your API Secret

Example:

0987654321dcba

• ⚠️ The API Secret will only be displayed once.
• Save it immediately in a secure password manager or vault.

Save and Close

Click Save and Close to return to the API Keys dashboard.

After closing:

• The API Secret cannot be viewed again
• Only the last 4 characters of the API Key will remain visible