SOCRadarIncidentsV4
SOCRadar Incidents v4 API integration with advanced incident management, status reasons, and compliance tracking. Fetches security incidents from SOCRadar platform with proper deduplication and date handling. Supports filtering by alarm type IDs for granular control.
Analytics & SIEM · SOCRadar
Details
| ID | SOCRadarIncidentsV4 |
|---|---|
| Provider | SOCRadar |
| Category | Analytics & SIEM |
| From Version | 6.10.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Supported Modules | Agentix XSIAM |
README
SOCRadar Incidents v4.0
Fetch and manage security incidents from SOCRadar’s Incident API v4 with advanced filtering, multi-status selection, and comprehensive incident enrichment.
Overview
SOCRadar is a digital risk protection platform that provides extended threat intelligence and brand protection capabilities. This integration enables XSOAR to ingest security incidents from SOCRadar’s Incident API v4, including:
- Brand Protection: Impersonating domains, phishing attacks, brand abuse
- Cyber Threat Intelligence: Stolen credentials, data leaks, malware infections
- Attack Surface Management: External exposure findings, misconfigurations
- Dark Web Intelligence: Compromised credentials, leaked data from dark web sources
- Supply Chain Security: Third-party risks and vendor security issues
What’s New in v4.0
Major Enhancements
- Multi-Status Filtering: Select multiple statuses (OPEN, CLOSED, ON_HOLD) simultaneously
- Epoch Time Precision: Second-level accuracy for incident fetching - zero duplicates
- Reverse Pagination: Fetches newest incidents first for better performance
- Dynamic Content Extraction: Automatically extracts alarm-specific fields regardless of type
- Parametric Company ID Display: Control whether company ID appears in incidents
- Enhanced Deduplication: Two-layer protection prevents duplicate incidents
- New Commands: Ask analyst, change severity, and more
Technical Improvements
- Interval-based fetching with overlap protection
- Configurable content and entity inclusion
- Integer company ID with validation
- Comprehensive debug logging
- Better error handling and recovery
Key Features
Incident Fetching
- Fetch incidents with configurable interval (default: 1 minute)
- Support for date ranges and epoch timestamps
- Automatic deduplication (tracks last 1000 alarm IDs)
- Reverse pagination for optimal performance
Flexible Filtering
- Multi-Status Selection: OPEN, CLOSED, ON_HOLD (multi-select)
- Severity Levels: LOW, MEDIUM, HIGH, CRITICAL
- Alarm Types: Filter by main type, sub-type, or type ID
- Custom Filters: Tags, assignees, date ranges
Rich Incident Data
- Dynamic CustomFields based on alarm type
- Configurable content extraction (varies by alarm type)
- Optional entity details inclusion
- Optional company ID visibility
Incident Management
- Change alarm status (11 status options)
- Add comments to alarms
- Change assignees
- Add/remove tags
- Request analyst assistance
- Modify severity levels
- Mark as false positive/resolved
Prerequisites
Required
- SOCRadar account with Incident API access
- API Key from SOCRadar platform
- Company ID
- XSOAR 6.x or later
API Access
To obtain your API credentials:
- Log in to SOCRadar Platform
- Navigate to Settings → API & Integrations
- Go to API Options page
- Copy your Company API Key (for Incident API)
- Note your Company ID
Configuration
Integration Settings
| Parameter | Required | Default | Description |
|---|---|---|---|
| Server URL | Yes | https://platform.socradar.com/api |
SOCRadar API base URL |
| API Key | Yes | - | Your Company API Key from SOCRadar |
| Company ID | Yes | - | Your Company ID (integer) |
| Fetch incidents | No | False | Enable automatic incident fetching |
| Incident type | No | - | XSOAR incident type to create |
| Max incidents per fetch | No | 10000 | Maximum incidents per fetch cycle |
| First fetch time | No | 3 days | Initial time range for first fetch |
| Fetch Interval (Minutes) | No | 1 | Time window for subsequent fetches |
Filtering Options
| Parameter | Type | Description |
|---|---|---|
| Status Filter | Multi-select | Select one or more: OPEN, CLOSED, ON_HOLD |
| Severity | Multi-select | Filter by: LOW, MEDIUM, HIGH, CRITICAL |
| Alarm Type IDs | Text | Comma-separated list of type IDs to include |
| Excluded Alarm Type IDs | Text | Comma-separated list of type IDs to exclude |
| Main Alarm Types | Text | Comma-separated main types (e.g., “Brand Protection”) |
| Alarm Sub Types | Text | Comma-separated sub types |
Content Options
| Parameter | Default | Description |
|---|---|---|
| Include Alarm Content | True | Extract content fields to CustomFields |
| Include Related Entities | True | Include entity details in CustomFields |
| Include Company ID | False | Show company ID in incidents (for multi-tenant) |
Installation
From XSOAR Marketplace
- Navigate to Settings → Marketplace
- Search for “SOCRadar”
- Click Install
- Configure integration instance
From GitHub (Manual)
# Clone the content repository
git clone https://github.com/demisto/content.git
cd content/Packs/SOCRadar
# Copy to your XSOAR instance
# Upload via Settings → Integrations → Upload
Setup Guide
Step 1: Create Integration Instance
- Navigate to Settings → Integrations → Servers & Services
- Search for “SOCRadar Incidents v4”
- Click Add instance
Step 2: Configure Basic Settings
Name: SOCRadar Production
Server URL: https://platform.socradar.com/api
API Key: [Your API Key from SOCRadar]
Company ID: [Your Company ID]
Step 3: Configure Fetching (Optional)
✓ Fetches incidents
Incident type: SOCRadar Incident
Max incidents per fetch: 10000
First fetch time: 3 days
Fetch Interval: 1 (minutes)
Step 4: Configure Filters (Optional)
Status Filter:
☑ OPEN
☐ CLOSED
☐ ON_HOLD
Content Options:
☑ Include Alarm Content in Custom Fields
☑ Include Related Entities Details
☐ Include Company ID in Incidents
Step 5: Test Connection
Click Test button to verify:
- API connectivity
- Authentication
- Company ID validity
Commands
Incident Management
socradar-change-alarm-status
Change the status of one or more alarms.
Arguments:
alarm_ids(Required): Comma-separated alarm IDs (e.g., “12345,67890”)status_reason(Required): New statusOPEN,INVESTIGATING,RESOLVED,PENDING_INFOLEGAL_REVIEW,VENDOR_ASSESSMENT,FALSE_POSITIVEDUPLICATE,PROCESSED_INTERNALLY,MITIGATED,NOT_APPLICABLE
comments(Optional): Status change commentscompany_id(Optional): Override default company ID
Example:
!socradar-change-alarm-status alarm_ids="81171696" status_reason="INVESTIGATING" comments="Under review"
From Incident Context:
!socradar-change-alarm-status alarm_ids=${incident.dbotMirrorId} status_reason="RESOLVED"
socradar-mark-false-positive
Mark alarm as false positive (shortcut command).
Arguments:
alarm_id(Required): Alarm IDcomments(Optional): Reason for false positivecompany_id(Optional): Override default company ID
Example:
!socradar-mark-false-positive alarm_id="81171696" comments="Not a real threat"
socradar-mark-resolved
Mark alarm as resolved (shortcut command).
Arguments:
alarm_id(Required): Alarm IDcomments(Optional): Resolution notescompany_id(Optional): Override default company ID
Example:
!socradar-mark-resolved alarm_id="81171696" comments="Issue fixed"
For Notes
socradar-add-comment
Add a comment to an alarm.
Arguments:
alarm_id(Required): Alarm IDuser_email(Required): Email of user posting commentcomment(Required): Comment textcompany_id(Optional): Override default company ID
Example:
!socradar-add-comment alarm_id="81171696" user_email="useremail" comment="Investigating with security team"
socradar-ask-analyst
Request assistance from SOCRadar analyst.
Arguments:
alarm_id(Required): Alarm IDcomment(Required): Message for analystcompany_id(Optional): Override default company ID
Example:
!socradar-ask-analyst alarm_id="81171696" comment="Need help analyzing this credential leak"
Assignment & Organization
socradar-add-assignee
Change alarm assignee(s).(User must be defined the same company)
Arguments:
alarm_id(Required): Alarm IDuser_emails(Required): Comma-separated email addressescompany_id(Optional): Override default company ID
Example:
!socradar-add-assignee alarm_id="81171696" user_emails="useremail"
socradar-add-tag
Add or remove a tag from alarm.
Arguments:
alarm_id(Required): Alarm IDtag(Required): Tag namecompany_id(Optional): Override default company ID
Example:
!socradar-add-tag alarm_id="81171696" tag="reviewed"
socradar-change-severity
Modify alarm severity level.
Arguments:
alarm_id(Required): Alarm IDseverity(Required): New severity (LOW, MEDIUM, HIGH, CRITICAL)company_id(Optional): Override default company ID
Example:
!socradar-change-severity alarm_id="81171696" severity="HIGH"
Testing
socradar-test-fetch
Test the fetch incidents functionality without creating incidents.
Arguments:
first_fetch(Optional): Time range to test (default: “3 days”)limit(Optional): Number of incidents to fetch (default: 5)
Example:
!socradar-test-fetch first_fetch="1 hour" limit="10"
Output:
Found 150 incident(s) from 2024-12-20!
Total available: 1000 records across 10 pages
Using REVERSE PAGINATION (page 10 → page 1)
Sample incidents:
- [81171696] HIGH | OPEN | example.com
Company: 789 | Type: Brand Protection / Impersonating Domain
Custom Fields
The integration creates these CustomFields in XSOAR incidents:
Standard Fields (Always Present)
socradaralarmid: Alarm IDsocradarstatus: Current statussocradarasset: Affected assetsocradaralarmtype: Main alarm typesocradaralarmsubtype: Alarm sub-typesocradaralarmtypeid: Type IDsocradartags: Comma-separated tagssocradarrisklevel: Risk levelsocradaralarmtext: Alarm description (truncated to 1000 chars)
Optional Fields
socradarcompanyid: Company ID (if “Include Company ID” enabled)socradarentities: Related entities (if “Include Entities” enabled)
Dynamic Content Fields (if “Include Content” enabled)
Content structure varies by alarm type. Examples:
Impersonating Domain:
socradarcontentdns_informationsocradarcontentwhois_informationsocradarcontentdomain_status
Stolen Credentials:
socradarcontentcredential_detailssocradarcontentlog_content_linksocradarcontentmalware_family
Data Leak:
socradarcontentsource_full_contentsocradarcontentcompromised_emailssocradarcontentcompromised_domains
Use Cases
1. Brand Protection
Scenario: Detect and respond to phishing domains impersonating your brand.
Configuration:
Main Alarm Types: Brand Protection
Status Filter: OPEN
Severity: HIGH, CRITICAL
Automation:
# Get incident
incident = demisto.incident()
alarm_id = incident.get('dbotMirrorId')
# Check domain details
domain_info = incident.get('CustomFields', {}).get('socradarcontentdns_information')
# Take action
demisto.executeCommand('socradar-add-assignee', {
'alarm_id': alarm_id,
'user_emails': 'useremail@usermail.com'
})
2. Multi-Tenant Operations (MSSP)
Scenario: Manage incidents for multiple customers.
Configuration:
Instance 1:
- Company ID: 789
- Include Company ID: ✓ YES
Instance 2:
- Company ID: 456
- Include Company ID: ✓ YES
Automation:
# Company ID is visible in CustomFields
company_id = incident.get('CustomFields', {}).get('socradarcompanyid')
# Route to appropriate team
if company_id == "789":
assign_to = "useremail"
else:
assign_to = "useremail"
demisto.executeCommand('socradar-add-assignee', {
'alarm_id': incident.get('dbotMirrorId'),
'user_emails': assign_to
})
Troubleshooting
No Incidents Fetched
Check:
- Test connection: Click “Test” button
- Date range: Increase “First fetch time” to “7 days”
- Filters: Remove status/severity filters temporarily
- Debug logs: Check XSOAR server logs
Debug Command:
!socradar-test-fetch first_fetch="7 days" limit="10"
Look for:
[SOCRadar V4.0] Total available: 0 records
If 0 records, no alarms match your filters.
Duplicate Incidents
This should NOT happen in v4.0! If you see duplicates:
- Check fetch interval: Should be ≥ 1 minute
-
Check logs for deduplication stats:
[SOCRadar V4.0] Page 1: Created 5 NEW incidents, skipped 95 duplicates -
Verify epoch time usage:
[SOCRadar V4.0] Time window (epoch seconds): 1734465600 to 1734465660
If duplicates persist, contact support with debug logs.
API Errors
401 Unauthorized:
- Verify API Key is correct
404 Not Found:
- Verify Company ID is correct (integer, not string)
- Check endpoint URLs in debug logs
Rate Limiting:
- Reduce fetch frequency
- Decrease “Max incidents per fetch”
Missing CustomFields
If dynamic content fields not appearing:
- Verify “Include Alarm Content” is enabled
- Create CustomFields manually in XSOAR:
- Settings → Advanced → Fields
- Add fields with type “Short Text”
- Prefix:
socradarcontent
If entities not appearing:
- Verify “Include Related Entities Details” is enabled
Performance Optimization
High-Volume Environments
Recommended Settings:
Max incidents per fetch: 10000
Fetch Interval: 5 (minutes)
Include Alarm Content: ✓ (enabled)
Include Related Entities: ✓ (enabled)
With Filters:
Status Filter: OPEN only
Severity: HIGH, CRITICAL only
This reduces data volume while capturing critical alerts.
Low-Volume Environments
Recommended Settings:
Max incidents per fetch: 1000
Fetch Interval: 1 (minutes)
Include Alarm Content: ✓ (enabled)
Include Related Entities: ✓ (enabled)
Faster response to new incidents.
Support
Official Support
- SOCRadar XSOAR Support: XSOAR@socradar.io
- SOCRadar Support: support@socradar.io
- Platform: platform.socradar.com
Feature Requests
Submit feature requests through:
- SOCRadar platform Request
- XSOAR content repository issues
Version History
v4.0.0 (December 2024)
- Initial release of SOCRadar Incidents v4.0
- Multi-status filtering support
- Epoch time precision for zero duplicates
- Reverse pagination implementation
- Dynamic content extraction
- Enhanced deduplication (2-layer)
- New commands: ask-analyst, change-severity
- Parametric company ID display
- Comprehensive debug logging
License
This integration is provided under the MIT License.
About SOCRadar
SOCRadar is a leading Extended Threat Intelligence (XTI) platform that helps organizations:
- Monitor and protect their digital assets
- Detect brand abuse and phishing attacks
- Identify stolen credentials and data leaks
- Track dark web activities
- Manage attack surface exposure
- Ensure supply chain security
Configuration parameters
apikey— (required)company_id— Company ID (required)isFetch— Fetch incidentsfirst_fetch— First Fetch Timefetch_interval_minutes— Fetch Interval (Minutes)max_fetch— Max incidents per fetchshow_content— Show Alarm Contentstatus— Status Filterseverities— Severity Levelsalarm_type_ids— Alarm Type IDs (Include)excluded_alarm_type_ids— Alarm Type IDs (Exclude)alarm_main_types— Alarm Main Typesexcluded_alarm_main_types— Alarm Main Types (Exclude)alarm_sub_types— Alarm Sub Typesexcluded_alarm_sub_types— Alarm Sub Types (Exclude)include_company_id— Include Company IDinclude_incident_link— Include Incident Linkinclude_mitigation— Include Mitigationinclude_response— Include Responseinclude_detection_and_analysis— Include Detection And Analysisinclude_post_incident_analysis— Include Post Incident Analysisinclude_related_assets— Include Related Assetsinclude_related_entities— Include Related Entitiesinsecure— Trust any certificate (not secure)proxy— Use system proxy settingsincidentType— Incident typeincidentFetchInterval— Incidents Fetch Interval
Commands (8)
-
socradar-add-assigneeadd the assignee(s) of an alarm.
-
socradar-add-commentAdd a comment to an alarm.
-
socradar-add-tagAdd or remove a tag from an alarm.
-
socradar-change-alarm-statusChange the status of one or more alarms.
-
socradar-change-assigneeDeprecatedadd the assignee(s) of an alarm.
-
socradar-mark-false-positiveMark an alarm as false positive.
-
socradar-mark-resolvedMark an alarm as resolved.
-
socradar-test-fetchTest incident fetching to verify alarms are available and date parsing works correctly.
SOCRadar is a leading Extended Threat Intelligence (XTI) platform that provides comprehensive digital risk protection. This integration enables XSOAR to ingest and manage security incidents from SOCRadar's Incident API v4. ## Key Capabilities ### Incident Types Supported - **Brand Protection**: Impersonating domains, phishing attacks, brand abuse - **Cyber Threat Intelligence**: Stolen credentials, data leaks, malware infections - **Attack Surface Management**: External exposure findings, misconfigurations - **Dark Web Intelligence**: Compromised credentials, leaked data from dark web sources - **Supply Chain Security**: Third-party risks and vendor security issues ### Advanced Features - **Multi-Status Filtering**: Select multiple statuses simultaneously for flexible queries - **Timestamp-Based Fetching**: Uses last_fetch timestamp to ensure consistent, duplicate-free incident ingestion - **Dynamic Content Extraction**: Automatically adapts to different alarm types - **Configurable Enrichment**: Control content and entity inclusion for performance - **Multi-Tenant Support**: Optional company_id parameter in all commands for MSSP environments ### Incident Management - Change status with multiple status options including OPEN, INVESTIGATING, RESOLVED, PENDING_INFO, LEGAL_REVIEW, VENDOR_ASSESSMENT, FALSE_POSITIVE, DUPLICATE, PROCESSED_INTERNALLY, MITIGATED, and NOT_APPLICABLE - Add comments and collaborate on investigations - Modify assignees and severity levels - Tag incidents for organization - Mark false positives and resolved items ## Getting Started 1. Obtain API credentials from SOCRadar platform (**Settings → API & Integrations → API Options**) 2. Copy your **Company API Key** (for Incident API) 3. Note your **Company ID** 4. Configure the integration in XSOAR with these credentials 5. Enable incident fetching and configure filters based on your requirements ## Configuration Tips - **First Fetch Time**: Set to a reasonable time range like "3 days" or "7 days" for initial setup - **Max Incidents Per Fetch**: Default is 200 for optimal performance and stability - **Alarm Type Filtering**: Use alarm_type_ids to include specific alarm types or excluded_alarm_type_ids to exclude certain types - **Status Filtering**: Filter by OPEN, CLOSED, or ON_HOLD statuses based on your workflow - **Multi-Tenant Support**: Use company_id parameter in commands for multi-tenant environments For detailed configuration and command documentation, see the integration README.