SOCRadar Incidents v4
This Integration is part of the SOCRadar Pack.#
Supported versions
Supported Cortex XSOAR versions: 6.10.0 and later.
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)#
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#
Step 3: Configure Fetching (Optional)#
Step 4: Configure Filters (Optional)#
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:
From Incident Context:
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-resolved#
Mark alarm as resolved (shortcut command).
Arguments:
alarm_id(Required): Alarm IDcomments(Optional): Resolution notescompany_id(Optional): Override default company ID
Example:
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-ask-analyst#
Request assistance from SOCRadar analyst.
Arguments:
alarm_id(Required): Alarm IDcomment(Required): Message for analystcompany_id(Optional): Override default company ID
Example:
Assignment & Organization#
socradar-change-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-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-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:
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:
Output:
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:
Automation:
2. Multi-Tenant Operations (MSSP)#
Scenario: Manage incidents for multiple customers.
Configuration:
Automation:
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:
Look for:
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:
Verify epoch time usage:
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:
With Filters:
This reduces data volume while capturing critical alerts.
Low-Volume Environments#
Recommended Settings:
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
Learn more: www.socradar.io
Made with โค๏ธ by the SOCRadar Integration Team and XSOAR teams