Integration Keys

About Integration Keys

Integration keys are used to authenticate to the Essentials Threat API & Security Awareness Reporting API

Creating an Integration Key for SIEM Threat Events or PESA Reporting API

To generate an integration key for accessing SIEM Threat Events or the PESA Reporting API, follow these steps:

1. Navigate to
   Go to Account Management > Integrations, then select the Integration Keys tab.

2. Add a New Key
   Click Add Integration Key in the upper right-hand corner.

3. Enter Key Details

   • Provide a description to help identify the purpose of the key.
   • In the Access Type dropdown, select either:
     • SIEM Threat Events
     • Security Awarness Reporting API
       Note: Security Awareness Reporting API access is restricted to “My Organisation Only”.

4. Set Scope

   • If you are part of an organisation, the Scope field will be locked to My Organisation Only.
   • If you are a partner, you can choose between:
     • My Organisation Only
     • My Organisation and All Child Organisations
       This determines whether the key can access data for child entities in the partner hierarchy.

5. Create and Save Credentials
   After clicking Create, you’ll receive two values:

   • API Key
      
   • API Key Secret
     These are required for authenticating to the Essentials Threat API or Security Awareness Reporting API,
     
     These values will not be shown again, please store them securely.

6. Activation Time
   The key may take up to 30 minutes to become active.

Deleting Integration Keys

1. Navigate to Account Management > Integrations and click on the Integration Keys tab.
2. Locate the key you want to delete and open the menu in the Actions column.
3. Click Delete API Key.
4. Confirm the deletion when prompted.

The key will be deactivated within 30 minutes. This action cannot be undone.