2.15 Settings Module
2.15 Settings Module
The Settings module manages security policies and organizational configuration for the Guardpot platform. The module provides five main tabs at the top level, as shown in Figure 2.15-1.
Figure 2.15-1 – Settings Module Overview
2.15.1 Main Navigation Tabs
The top-level tab bar provides access to the following configuration areas:
Tab | Description |
|---|---|
Policies | Security policy management center for credentials, events, and interactions |
Global Exception List | Manage IPs excluded from security checks |
Company Settings | Organization profile, license status, and usage statistics |
Company Person | Personnel management with seat allocation and invitations |
License Status | Detailed license information, credits, and purchase history |
2.15.2 Policies Tab
The Policies tab is the central hub for configuring security policies. Selecting this tab reveals a secondary tab bar with three policy categories, as shown in Figure 2.15.2-1.
Figure 2.15.2-1 – Policies Tab with Sub-Tabs
Sub-Tab | Description |
|---|---|
Credentials | Manage credential-based detection policies |
Event | Configure event-based trigger policies |
Interaction | Set interaction monitoring rules |
A left sidebar within the Policies tab provides additional navigation options that change based on the selected sub-tab.
2.15.2.1 Credentials Sub-Tab
The Credentials sub-tab manages credential-based security policies. The main panel displays the Credential Policy List table, as shown in Figure 2.15.2.1-1.
Figure 2.15.2.1-1 – Credentials Sub-Tab
Credential Policy List Table:
Column | Description |
|---|---|
Name | Policy identifier |
Type | Policy classification (e.g., LIST) |
Control List | Items governed by this policy |
Exception List | Excluded items from the policy |
LDAP | LDAP integration status |
Hit Count | Number of times the policy was triggered |
Actions | Edit, Detail, and Delete buttons |
Left Sidebar Menu:
The left sidebar within the Credentials sub-tab provides the following options:
Menu Item | Description |
|---|---|
Credential List | View and manage credential policies |
Exception List | Manage exception entries for credential policies |
LDAP List | Configure LDAP/Active Directory integrations |
Alert Policy | Configure alert notification rules for credential events |
New Policy | Create new credential policies |
2.15.2.1.1 Credential List
Clicking Credential List in the left sidebar displays the credential policy overview, as shown in Figure 2.15.2.1.1-1.
Figure 2.15.2.1.1-1 – Credential List View
The header displays the total count:
1 Total Credential
The list displays two columns:
Column | Description |
|---|---|
Name | Policy name with icon |
Actions | Three action buttons |
Action Buttons:
Button | Function |
|---|---|
Update Credential | Edit the credential policy |
Credential List Detail | View detailed policy information |
Delete | Remove the credential policy |
Adding a New Credential:
Click the + button in the Credential List section to open the creation form, as shown in Figure 2.15.2.1.1-2.
Figure 2.15.2.1.1-2 – Create Credential Form
The form is titled "Create Credential" with the subtitle "Fill required details below to continue." and includes:
Parameter | Description |
|---|---|
Name | A descriptive name for the credential entry |
Credential | The credential value (username/password combination) |
2.15.2.1.2 Exception List
Clicking Exception List in the left sidebar displays the exception entries for credential policies. The interface includes a table with Name and Actions columns, along with an Add button.
Clicking the Add button opens the exception creation form with the following parameters:
Parameter | Description |
|---|---|
Name | A descriptive name for the exception |
Credential | The credential value to exclude from detection |
2.15.2.1.3 LDAP List
Clicking LDAP List in the left sidebar displays configured LDAP integrations in a table with Name and Actions columns, as shown in Figure 2.15.2.1.3-1.
Figure 2.15.2.1.3-1 – LDAP List View
Click the + button to add a new LDAP configuration. The form is titled "Create Ldap" with the subtitle "Fill required details below to continue." and includes:
Parameter | Description |
|---|---|
Name | A descriptive name for the LDAP connection |
URL | LDAP server URL |
Start TLS | Toggle to enable TLS encryption |
Bind User | Username for LDAP binding |
Bind Password | Password for the bind user |
Connection Certificate | Certificate for the LDAP connection |
TLS Certificate | TLS certificate file |
TLS Key | TLS key file |
Certificate Validation | Toggle to enable certificate validation |
Ldap Extension | Additional LDAP extension parameters |
2.15.2.1.4 Alert Policy
Clicking Alert Policy in the left sidebar opens the alert notification configuration for credential events, as shown in Figure 2.15.2.1.4-1.
Figure 2.15.2.1.4-1 – Alert Policy Configuration
Add User or Group Section:
Parameter | Description |
|---|---|
Select Policy | Choose an existing policy to associate with alerts |
Select User or Group | Choose users or groups to receive notifications |
Notification Channels:
Select one or more channels by clicking on them. Multiple channels can be enabled simultaneously:
Channel |
|---|
call |
sms |
push |
slack |
discord |
telegram |
Alert Message Template:
Build the alert message by clicking on template variables to insert them into the message. Available variable categories:
Time:
Variable |
|---|
Time |
Credentials:
Variable |
|---|
Username |
Password |
Location:
Variable |
|---|
Agent Location |
Attacker Location |
Header:
Variable |
|---|
Agent Name |
Agent IP |
Agent Description |
Agent OS |
Other Logs:
Variable |
|---|
Port |
Attack Time |
Attack Type |
Attacker IP |
2.15.2.1.5 New Policy
Clicking New Policy in the left sidebar opens the credential policy creation form, as shown in Figure 2.15.2.1.5-1.
Figure 2.15.2.1.5-1 – New Policy Form
The form is titled "New Policy" with the subtitle "Fill required details below to continue." and includes:
Parameter | Description |
|---|---|
Name | A descriptive name for the new policy |
Guardpot | Select a Guardpot agent from the dropdown (displays "Please Select an Guardpot") |
Policy Type | Policy classification (e.g., List) |
Credential List | Select credential entries to include |
Exception List (Optional) | Select exception entries to exclude |
2.15.2.2 Event Sub-Tab
The Event sub-tab manages event-based trigger policies. The main panel displays the Event Policy List, as shown in Figure 2.15.2.2-1.
Figure 2.15.2.2-1 – Event Sub-Tab
Event Policy List Header:
0 Total Event Policy
Empty State:
No Data
Left Sidebar Menu:
The left sidebar within the Event sub-tab provides two options:
Menu Item | Description |
|---|---|
Alert Policy | Configure alert notification rules for event triggers |
New Policy | Create new event-based policies |
2.15.2.2.1 Alert Policy
Clicking Alert Policy in the left sidebar opens the alert notification configuration for event triggers. The interface is identical to the Credentials Alert Policy described in 2.15.2.1.4, with the same notification channels (email, call, sms, push, slack, discord, telegram) and alert message template variables (Time, Username, Password, Agent Location, Attacker Location, Agent Name, Agent IP, Agent Description, Agent OS, Port, Attack Time, Attack Type, Attacker IP).
2.15.2.2.2 New Policy
Clicking New Policy in the left sidebar opens the event policy creation form, as shown in Figure 2.15.2.2.2-1.
Figure 2.15.2.2.2-1 – New Event Policy Form
The form includes the following parameters:
Parameter | Description |
|---|---|
Name | A descriptive name for the event policy |
Agent | Select a Guardpot agent from the dropdown |
IP List | IP address filter; select ANY to match all addresses |
Attack Type List | Select attack types to monitor; select ANY to match all types |
Available Attack Types:
Attack Type |
|---|
database |
web |
ssh |
dns |
portscan |
2.15.2.3 Interaction Sub-Tab
The Interaction sub-tab manages interaction monitoring rules. The main panel displays the Interaction Policy List, as shown in Figure 2.15.2.3-1.
Figure 2.15.2.3-1 – Interaction Sub-Tab
Interaction Policy List Header:
0 Total Interaction Policy
Empty State:
No Data
Left Sidebar Menu:
The left sidebar within the Interaction sub-tab provides two options:
Menu Item | Description |
|---|---|
Alert Policy | Configure alert notification rules for interaction events |
New Policy | Create new interaction-based policies |
2.15.2.3.1 Alert Policy
Clicking Alert Policy in the left sidebar opens the alert notification configuration for interaction events. The interface is identical to the Credentials Alert Policy described in 2.15.2.1.4, with the same notification channels (email, call, sms, push, slack, discord, telegram) and alert message template variables (Time, Username, Password, Agent Location, Attacker Location, Agent Name, Agent IP, Agent Description, Agent OS, Port, Attack Time, Attack Type, Attacker IP).
2.15.2.3.2 New Policy
Clicking New Policy in the left sidebar opens the interaction policy creation form, as shown in Figure 2.15.2.3.2-1.
Figure 2.15.2.3.2-1 – New Interaction Policy Form
The form is titled "New Interaction Policy" with the subtitle "Fill required details below to continue." and includes:
Parameter | Description |
|---|---|
Name | A descriptive name for the interaction policy |
Guardpot | Select a Guardpot agent from the dropdown |
IP List | IP address filter; select ANY to match all addresses |
Interaction Type | Select the interaction type to monitor |
Find Detail | Search pattern field. Use |
2.15.3 Global Exception List Tab
The Global Exception List tab manages IP addresses excluded from security checks, as shown in Figure 2.15.3-1.
Figure 2.15.3-1 – Global Exception List Tab
2.15.3.1 Header
The tab header displays:
Global Exception List — Manage IPs that should be excluded from security checks
2.15.3.2 Adding an Exception IP
An Enter IP address text field paired with an Add IP button allows adding IP addresses to the global exception list.
2.15.3.3 Exception List Table
The table displays configured exception IPs with the following columns:
Column | Description |
|---|---|
IP Address | The excluded IP address |
Actions | Delete |
2.15.4 Company Settings Tab
The Company Settings tab displays organizational profile, license status, and operational statistics, as shown in Figure 2.15.4-1.
Figure 2.15.4-1 – Company Settings Tab
2.15.4.1 My Company Card
The My Company card displays the following summary information:
Metric | Description |
|---|---|
Total Payment | Cumulative payment amount (e.g., 0) |
Total Agent | Number of deployed agents (e.g., 4) |
License | License tier icon and status |
Expire Date | License expiration date (e.g., 20.10.2030 06:55:06) |
License Status | Status message (e.g., "Great — Your license will expire within 1614 days.") |
Clicking the Edit icon on the My Company card opens the Company Update form:
Parameter | Description |
|---|---|
Company Name | Organization name |
Website URL | Company website (no |
Description | Company description |
Upload Company Picture | Update the company logo/image |
2.15.4.2 Personnel Who Resolve the Most Alarms
Displays the top performing personnel with alert resolution statistics:
Field | Description |
|---|---|
Name | Personnel name (e.g., "Guardpot Admin") |
Contact email (e.g., | |
Alert Count | Number of alerts resolved (e.g., "1 Alert") |
2.15.4.3 Agents That Create the Most Alarms
Displays the agents generating the highest alarm volume:
Field | Description |
|---|---|
Agent Name | Agent identifier (e.g., "PotGuard(Deleted)") |
Alarm Count | Total alarms generated (e.g., 14) |
2.15.4.4 Summary Counters
Counter | Description |
|---|---|
Person | Personnel count |
Total User | Total system users (e.g., 1) |
Total Admin | Total administrators (e.g., 1) |
Action buttons:
Button | Function |
|---|---|
See Details | View detailed personnel information |
See Details | View detailed license information |
2.15.5 Company Person Tab
The Company Person tab manages personnel, seat allocation, and user invitations, as shown in Figure 2.15.5-1.
Figure 2.15.5-1 – Company Person Tab
2.15.5.1 My Company Card
Displays company membership overview:
Metric | Description |
|---|---|
Join Date | Company registration date (e.g., 15.02.2024 12:10:42) |
Personnel | Total personnel count (e.g., 1) |
Admin | Administrator count (e.g., 1) |
Agent | Agent count (e.g., 4) |
License | License tier (e.g., Enterprise) |
Total Seat | Seat usage (e.g., 2 / 20) |
2.15.5.2 Seat Management
The seat allocation display shows 2 / 20 Total Seat with two buttons:
Button | Function |
|---|---|
Invite | Send an email invitation to add a new user |
My Invites | View the invitation list and status |
Invite:
Clicking Invite opens a form where the target email address is entered and an invitation to join the company is sent.
My Invites:
Clicking My Invites opens the Invite List with the following columns:
Column | Description |
|---|---|
Invited | Invited email address |
Invited By | Administrator who sent the invitation |
Insert Date | When the invitation was sent |
Invite Key | Unique invitation identifier |
Validity Date | When the invitation expires |
2.15.5.3 Person List Table
Displays all company personnel with the following columns:
Column | Description |
|---|---|
Name | User display name (e.g., "Guardpot Admin", "Demo User") |
Role | User role: Admin or User |
Insert Date | Account creation date (e.g., "04.11.2023 01:42:55") |
Username | Email/username (e.g., |
Actions | Update User Permission, Guardpot Admin Logs, and Delete |
Action Buttons:
Button | Function |
|---|---|
Update User Permission | Modify user role and permissions |
Guardpot Admin Logs | View user activity logs |
Delete | Remove the user |
2.15.5.4 Personnel Detail Panel
Clicking on a user displays their detail panel.
Guardpot Admin Details:
Field | Description |
|---|---|
Name | "Guardpot Admin" |
Alarm Statistics:
Metric | Description |
|---|---|
Change in the last 7 days | Recent alarm trend (e.g., "Not Changed") |
Total Alarms | All alarms (e.g., "17 Alarm") |
Waiting Alarms | Pending alarms (e.g., "12 Alarm") |
Solved Alarms | Resolved alarms (e.g., "1 Alarm") |
Taken Alarms | Assigned alarms (e.g., "4 Alarm") |
2.15.6 License Status Tab
The License Status tab provides comprehensive license information, credits, and purchase history, as shown in Figure 2.15.6-1.
Figure 2.15.6-1 – License Status Tab
2.15.6.1 License Overview
The top section displays the current license plan and pricing:
Field | Description |
|---|---|
Price | Monthly license cost (e.g., "$150.00 Monthly") |
License Tier | Enterprise License |
Call Count | Available call notifications (e.g., 250) |
SMS Count | Available SMS notifications (e.g., 500) |
2.15.6.2 Licensed Features
Four feature cards display enabled capabilities:
Feature | Description |
|---|---|
ATTACK SURFACE | Attack surface management included |
NETWORK TESTER | Network testing capabilities included |
VGN VPN | Virtual Guarded Network VPN included |
DECEPTION | Deception technology included |
2.15.6.3 Usage Summary
Metric | Description |
|---|---|
Licensed User | Current usage and remaining seats (e.g., "Left : 18") |
Total Admin | Administrator count (e.g., 1) |
Total User | Total user count (e.g., 2) |
2.15.6.4 Guardpots Section
Displays the current Guardpot count for the company.
2.15.6.5 Credit Section
Displays all included and purchased credits:
Metric | Description |
|---|---|
Credit | Overall credit balance (e.g., 30/100000) |
2.15.6.6 Notifications Section
Displays notification credit balances:
Metric | Description |
|---|---|
Credit | General notification credits (e.g., 700) |
SMS Notification | SMS-specific credits (e.g., 500) |
Call Notification | Call-specific credits |
2.15.6.7 Special Code
Clicking the Special Code button opens a text field where a special license code can be entered for activation or upgrades.
2.15.6.8 Purchase History Table
Displays all license purchases with the following columns:
Column | Description |
|---|---|
Name | Purchase identifier (e.g., "My Company 484a505753") |
User | Purchasing user (e.g., "Guardpot Admin") |
Price | Purchase amount (e.g., "$0") |
Date | Purchase date (e.g., "11.03.2026 20:11:56") |
A Search field allows filtering through purchase history entries.