Fortinet FortiSIEM v5.2.0

About the connector

Fortinet FortiSIEM is a highly scalable multi-tenant Security Information and Event Management (SIEM) solution that provides real-time infrastructure and user awareness for accurate threat detection, analysis, and reporting.

This document provides information about the Fortinet FortiSIEM Connector, which facilitates automated interactions with your Fortinet FortiSIEM server using FortiSOAR™ playbooks. Add the Fortinet FortiSIEM Connector, as a step in FortiSOAR™ playbooks and perform automated operations such as retrieving device information for all devices configured on the Fortinet FortiSIEM server and retrieving a list of monitored organizations from the Fortinet FortiSIEM server.

You can use FortiSOAR™'s Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling incidents from Fortinet FortiSIEM.

For more information, see the Data Ingestion Support section.

For a list of recommendations and suggested best practices for working with the FortiSOAR FortiSIEM integration, see the Best Practices - Working with FortiSOAR FortiSIEM Integration section.

FortiSIEM 6.7.6 release contained some API changes that led to updates in connector actions. For details see the Fortinet FortiSIEM v5.1.0 connector document.

Version information

Connector Version: 5.2.0

FortiSOAR™ Version Tested on: 7.4.3-3294

Fortinet FortiSIEM Version Tested on: 7.1.0

Authored By: Fortinet

Certified: Yes

Release Notes for version 5.2.0

Following enhancements have been made to the Fortinet FortiSIEM Connector in version 5.2.0:

• Added the following actions:
  • Get IP Context
  • Get Host Context
  • Get User Context
• Deprecated the following actions:
  • Get All Resource Lists
  • Get Resource List Entries
  • Add Entries To Resource List
  • Remove Entries From Resource List
• Updated output schema for following actions:
  • List Incidents
  • Get Incident Details

Important Notes related to this release of the connector

• Only FortiSIEM v7.1.0 and later are supported by this connector version.
• The FortiSIEM API no longer supports filtering incidents based on sub-categories in the List Incidents action.
• The Time From and Time To parameters in the Get Events For Incident action are supported only in the FortiSIEM v6.7.6.

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the following yum command as a root user to install connectors from an SSH session:

yum install cyops-connector-fortinet-fortisiem

Prerequisites to configuring the connector

• You must have the URL of a Fortinet FortiSIEM server to which you will connect and perform automated operations and the credentials, such as the username and password, to access that server.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiSIEM server.

Minimum Permissions Required

• The minimum privileges that require to be assigned to users who are going to use this connector and run actions on FortiSIEM are Read and Update access on Incidents and access to Run Advanced Search Query.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Fortinet FortiSIEM connector card. On the connector popup, click the Configurations tab to enter the required configuration details:

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™:

operation: Get All Devices

Input parameters

Output

The output contains the following populated JSON schema:

{
    "devices": {
        "device": [
            {
                "name": "",
                "accessIp": "",
                "approved": "",
                "creationMethod": "",
                "discoverMethod": "",
                "discoverTime": "",
                "naturalId": "",
                "unmanaged": "",
                "updateMethod": "",
                "version": "",
                "deviceType": {
                    "accessProtocols": "",
                    "jobWeight": "",
                    "model": "",
                    "vendor": "",
                    "version": ""
                },
                "organization": {
                    "@id": "",
                    "@name": ""
                }
            }
        ]
    }
}

operation: Get All Devices For Specified IP Address Range

Input parameters

Output

The output contains the following populated JSON schema:

{
    "devices": {
        "device": [
            {
                "name": "",
                "accessIp": "",
                "approved": "",
                "creationMethod": "",
                "discoverMethod": "",
                "discoverTime": "",
                "naturalId": "",
                "unmanaged": "",
                "updateMethod": "",
                "version": "",
                "deviceType": {
                    "accessProtocols": "",
                    "jobWeight": "",
                    "model": "",
                    "vendor": "",
                    "version": ""
                },
                "organization": {
                    "@id": "",
                    "@name": ""
                }
            }
        ]
    }
}

operation: Get Device Information

Input parameters

Output

The output contains the following populated JSON schema:

{
    "device": {
        "luns": "",
        "name": "",
        "status": "",
        "version": "",
        "accessIp": "",
        "approved": "",
        "storages": "",
        "naturalId": "",
        "unmanaged": "",
        "components": "",
        "deviceType": {
            "model": "",
            "vendor": "",
            "version": "",
            "category": "",
            "jobWeight": ""
        },
        "interfaces": {
            "networkinterface": {
                "adminStatus": "",
                "description": "",
                "inSpeed": "",
                "ipv4Addr": "",
                "ipv4IsVirtual": "",
                "ipv4Mask": "",
                "isCritical": "",
                "isMonitor": "",
                "isTrunk": "",
                "isWAN": "",
                "macAddr": "",
                "macIsVirtual": "",
                "name": "",
                "operStatus": "",
                "outSpeed": "",
                "snmpIndex": "",
                "speed": "",
                "type": ""
            }
        },
        "processors": "",
        "raidGroups": "",
        "applications": "",
        "discoverTime": "",
        "organization": {
            "@id": "",
            "@name": ""
        },
        "updateMethod": "",
        "ipToHostNames": "",
        "storageGroups": "",
        "creationMethod": "",
        "description": "",
        "discoverMethod": "",
        "winMachineGuid": "",
        "eventParserList": "",
        "systemUpTime": "",
        "softwarePatches": "",
        "softwareServices": "",
        "sanControllerPorts": ""
    }
}

operation: List Monitored Devices and Attributes

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "monitoredDevices": {
        "perfMonDevices": {
            "device": {
                "accessIp": "",
                "deviceName": "",
                "deviceType": "",
                "monitors": {
                    "monitor": [
                        {
                            "category": "",
                            "method": ""
                        }
                    ]
                },
                "organization": ""
            }
        },
        "eventPullingDevices": ""
    }
}

operation: List Monitored Organizations

Input parameters

None.

Output

The output contains the following populated JSON schema:

[
    {
        "@id": "",
        "name": "",
        "@xmlId": "",
        "@custId": "",
        "@ownerId": "",
        "disabled": "",
        "domainId": "",
        "initialized": "",
        "@creationTime": "",
        "collectors": {
            "collector": []
        },
        "@lastModified": "",
        "@entityVersion": "",
        "custProperties": ""
    }
]

operation: Get Organization Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "@entityVersion": "",
    "@creationTime": "",
    "@custId": "",
    "@id": "",
    "@lastModified": "",
    "custProperties": "",
    "collectors": {
        "collector": []
    },
    "@ownerId": "",
    "@xmlId": "",
    "disabled": "",
    "domainId": "",
    "initialized": "",
    "name": ""
}

operation: List Incidents

Input parameters

Important: The FortiSIEM API does not support filtering incidents in the "List Incident" action based on sub-categories.

{
    "status": [
        0
    ],
    "eventType": [
        "PH_RULE_SERVER_CPU_WARN"
    ],
    "incidentRptIp": [
        "10.7.12.156"
    ]
}
                

Output

The output contains the following populated JSON schema:

{
    "data": [
        {
            "count": "",
            "tactic": "",
            "customer": "",
            "eventName": "",
            "eventType": "",
            "technique": "",
            "incidentId": "",
            "incidentSrc": {
                "srcIpAddr": "",
                "computer": ""
            },
            "attackTactic": "",
            "incidentReso": "",
            "eventSeverity": "",
            "incidentRptIp": "",
            "incidentTitle": "",
            "incidentDetail": "",
            "incidentStatus": "",
            "incidentTarget": {
                "user": "",
                "domain": "",
                "hostName": "",
                "hostIpAddr": "",
                "targetUser": "",
                "targetDomain": "",
                "destIpAddr": "",
                "destIpPort": ""
            },
            "attackTechnique": [
                {
                    "name": "",
                    "techniqueid": ""
                }
            ],
            "eventSeverityCat": "",
            "incidentLastSeen": "",
            "incidentFirstSeen": "",
            "incidentStatusStr": "",
            "incidentRptDevName": "",
            "phIncidentCategory": "",
            "incidentClearedTime": "",
            "incidentClearedReason": "",
            "phSubIncidentCategory": "",
            "destName": ""
        }
    ]
}

operation: Get Incident Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "pages": "",
    "total": "",
    "queryId": "",
    "sizePerPage": "",
    "data": [
        {
            "incidentTitle": "",
            "eventSeverity": "",
            "incidentFirstSeen": "",
            "incidentReso": "",
            "incidentRptIp": "",
            "incidentLastSeen": "",
            "incidentSrc": "",
            "count": "",
            "attackTechnique": "",
            "eventType": "",
            "phIncidentCategory": "",
            "incidentClearedTime": "",
            "incidentTarget": "",
            "attackTactic": "",
            "phSubIncidentCategory": "",
            "eventSeverityCat": "",
            "incidentDetail": "",
            "incidentRptDevName": "",
            "eventName": "",
            "incidentId": "",
            "incidentStatus": "",
            "customer": ""
        }
    ],
    "start": ""
}

operation: Comment Incident

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": "",
    "incident_id": ""
}

operation: Clear Incident With Reason

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": "",
    "incident_id": []
}

operation: Get Events For Incident

Input parameters

Output

The output contains the following populated JSON schema:

[
    {
        "id": "",
        "nid": "",
        "index": 0,
        "custId": 2000,
        "dataStr": {},
        "eventType": "",
        "attributes": {
            "Count": "",
            "Event ID": "",
            "Source IP": "",
            "Time skew": "",
            "Event Type": "",
            "Attack Name": "",
            "Device Time": "",
            "Relaying IP": "",
            "Collector ID": "",
            "Malware Name": "",
            "Reporting IP": "",
            "Raw Event Log": "",
            "Destination IP": "",
            "Event Severity": "",
            "Organization ID": "",
            "Reporting Model": "",
            "Reporting Device": "",
            "Reporting Vendor": "",
            "Source Host Name": "",
            "Virus/Malware ID": "",
            "Event Parser Name": "",
            "Organization Name": "",
            "Event Parse Status": "",
            "Event Receive Time": "",
            "Event Rule Trigger": "",
            "Source TCP/UDP Port": "",
            "Destination Host Name": "",
            "System Event Category": "",
            "Event Severity Category": "",
            "Destination TCP/UDP Port": "",
            "External Event Receive Protocol": ""
        },
        "rawMessage": "",
        "receiveTime": "",
        "eventAttributes": []
    }
]

operation: Run Advanced Search Query

Input parameters

Output

No output schema is available currently.

operation: Update Incident

Input parameters

Output

The output contains the following populated JSON schema:

{
    "message": "",
    "incident_id": ""
}

operation: Get Event Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "nid": "",
    "index": "",
    "custId": "",
    "dataStr": "",
    "eventType": "",
    "attributes": {
        "uuid": "",
        "vdom": "",
        "count": "",
        "fwRule": "",
        "eventId": "",
        "ipProto": "",
        "srcName": "",
        "subtype": "",
        "customer": "",
        "destName": "",
        "fwAction": "",
        "logLevel": "",
        "memberID": "",
        "totFlows": "",
        "trandisp": "",
        "eventName": "",
        "eventType": "",
        "reptModel": "",
        "sessionId": "",
        "srcIpAddr": "",
        "srcIpPort": "",
        "totPkts64": "",
        "destGeoOrg": "",
        "destIpAddr": "",
        "destIpPort": "",
        "deviceTime": "",
        "parserName": "",
        "phRecvTime": "",
        "recvPkts64": "",
        "reptVendor": "",
        "sentPkts64": "",
        "totBytes64": "",
        "collectorId": "",
        "destGeoCity": "",
        "eventAction": "",
        "rawEventMsg": "",
        "hostIpAddr": "",
        "hostName": "",
        "recvBytes64": "",
        "reptDevName": "",
        "sentBytes64": "",
        "serviceName": "",
        "srcIntfName": "",
        "timeSkewSec": "",
        "appGroupName": "",
        "destGeoState": "",
        "destIntfName": "",
        "durationMSec": "",
        "eventParsedOk": "",
        "eventSeverity": "",
        "reptDevIpAddr": "",
        "destGeoCountry": "",
        "profileDetails": "",
        "relayDevIpAddr": "",
        "destGeoLatitude": "",
        "phEventCategory": "",
        "destGeoLongitude": "",
        "eventRuleTrigger": "",
        "eventSeverityCat": "",
        "postNATSrcIpAddr": "",
        "postNATSrcIpPort": "",
        "extEventRecvProto": "",
        "destGeoCountryCodeStr": ""
    },
    "receiveTime": ""
}

operation: Search Events

Input parameters

Output

The output contains the following populated JSON schema:

{
    "@start": "",
    "events": [
        {
            "id": "",
            "nid": "",
            "index": "",
            "custId": "",
            "dataStr": "",
            "eventType": "",
            "attributes": {
                "type": "",
                "uuid": "",
                "vdom": "",
                "count": "",
                "fwRule": "",
                "osType": "",
                "eventId": "",
                "ipProto": "",
                "srcName": "",
                "subtype": "",
                "customer": "",
                "destName": "",
                "fwAction": "",
                "logLevel": "",
                "memberID": "",
                "totFlows": "",
                "trandisp": "",
                "eventName": "",
                "eventType": "",
                "reptModel": "",
                "sessionId": "",
                "srcIpAddr": "",
                "srcIpPort": "",
                "totPkts64": "",
                "destIpAddr": "",
                "destIpPort": "",
                "deviceTime": "",
                "parserName": "",
                "phRecvTime": "",
                "recvPkts64": "",
                "reptVendor": "",
                "sentPkts64": "",
                "srcMACAddr": "",
                "totBytes64": "",
                "collectorId": "",
                "eventAction": "",
                "rawEventMsg": "",
                "recvBytes64": "",
                "reptDevName": "",
                "sentBytes64": "",
                "serviceName": "",
                "srcIntfName": "",
                "timeSkewSec": "",
                "appGroupName": "",
                "destIntfName": "",
                "durationMSec": "",
                "eventParsedOk": "",
                "eventSeverity": "",
                "reptDevIpAddr": "",
                "profileDetails": "",
                "relayDevIpAddr": "",
                "phEventCategory": "",
                "eventRuleTrigger": "",
                "eventSeverityCat": "",
                "masterSrcMACAddr": "",
                "postNATSrcIpAddr": "",
                "postNATSrcIpPort": "",
                "extEventRecvProto": ""
            },
            "receiveTime": ""
        }
    ],
    "@queryId": "",
    "@errorCode": "",
    "@totalCount": ""
}

operation: Get Event Attributes

Input parameters

None.

Output

{
    "FQDN": "",
    "Type": "",
    "UUID": "",
    "User": "",
    "VM IP": "",
    "Domain": "",
    "Host IP": "",
    "ICMP Id": "",
    "IP Port": "",
    "Message": "",
    "User Id": "",
    "Agent ID": "",
    "Checksum": "",
    "Computer": "",
    "Duration": "",
    "Event ID": "",
    "Host MAC": "",
    "URI Stem": "",
    "Disk Name": "",
    "File Name": "",
    "File Path": "",
    "Host City": "",
    "Host Name": "",
    "Host VLAN": "",
    "ICMP Code": "",
    "ICMP Type": "",
    "Rule Name": "",
    "Server IP": "",
    "TCP flags": "",
    "URI Query": "",
    "WLAN SSID": "",
    "Event Name": "",
    "Event Type": "",
    "File Owner": "",
    "Host Model": "",
    "Host State": "",
    "IP Version": "",
    "Image File": "",
    "Sent Bytes": "",
    "Source IP ": "",
    "Source MAC": "",
    "Source TOS": "",
    "User Group": "",
    "VPN Status": "",
    "Attack Name": "",
    "Device Port": "",
    "Device Time": "",
    "Employee ID": "",
    "Host Vendor": "",
    "IP Protocol": "",
    "Incident ID": "",
    "Mail Sender": "",
    "New Host IP": "",
    "Object Name": "",
    "Relaying IP": "",
    "Server Name": "",
    "Source City": "",
    "Source VLAN": "",
    "Target User": "",
    "Total Bytes": "",
    "Collector ID": "",
    "Collector IP": "",
    "DHCP Gateway": "",
    "Event Action": ": ",
    "Event Source": "",
    "Host Country": "",
    "Mail Subject": "",
    "Malware Name": "",
    "Malware Type": "",
    "Process Name": "",
    "Reporting IP": ": ",
    "Sent Packets": "",
    "Source State": "",
    "VM Host Name": "",
    "Win Logon Id": "",
    "ARP Source IP": "",
    "Connection Id": "",
    "DNS Server IP": "",
    "IPS Sensor Id": "",
    "Mail Receiver": "",
    "Object Handle": "",
    "Raw Event Log": "",
    "Software Name": "",
    "Target Domain": "",
    "Total Packets": "",
    "VPN Conn Type": "",
    "WLAN Radio Id": "",
    "ARP Source MAC": "",
    "Account Number": "",
    "Auth Server IP": "",
    "Collector Name": "",
    "DNS Query Type": "",
    "Destination IP": "",
    "Event Severity": "",
    "Hash Algorithm": "",
    "Incident Title": "",
    "Malware Action": "",
    "OS Object Type": "",
    "Received Bytes": "",
    "Recv Auth Fail": "",
    "Reporting City": "",
    "Sent TCP flags": "",
    "Snort Event ID": "",
    "Source Country": "",
    "TCP Connection": "",
    "UDP Connection": "",
    "Win Logon Type": "",
    "DHCP Server MAC": "",
    "Destination MAC": "",
    "Destination TOS": "",
    "Firewall Action": "",
    "HTTP User Agent": "",
    "Host Virtual IP": "",
    "ICMP Connection": "",
    "Incident Source": "",
    "Incident Target": "",
    "Organization ID": "",
    "Relaying Device": "",
    "Reporting Model": "",
    "Reporting State": "",
    "Target Computer": "",
    "Target Host MAC": "",
    "VPN Tunnel Name": "",
    "WLAN Channel Id": "",
    "WLAN User count": "",
    "Application Name": "",
    "Application Port": "",
    "Auth Server Name": "",
    "Destination City": "",
    "Destination VLAN": "",
    "Event Occur Time": "",
    "Firewall Session": "",
    "Operating System": "",
    "Received Packets": "",
    "Reporting Device": "",
    "Reporting Vendor": "",
    "Source Host Name": "",
    "DHCP Request Type": "",
    "Destination State": "",
    "Event Description": "",
    "Host Organization": "",
    "Incident Category": "",
    "Informational URL": "",
    "Organization Name": "",
    "Reporting Country": "",
    "Target User Group": "",
    "ARP Destination IP": "",
    "Event Parse Status": "",
    "Event Receive Time": "",
    "IP Type of Service": "",
    "Object Access Type": "",
    "Post-NAT Source IP": "",
    "Previous Source IP": "",
    "Recv Packet Errors": "",
    "Sent Packet Errors": "",
    "Source Device Port": "",
    "Vulnerability Name": "",
    "Vulnerability Type": "",
    "ARP Destination MAC": "",
    "Destination Country": "",
    "Host Interface Name": "",
    "Recv Interface Util": "",
    "Sent Interface Util": "",
    "Source Organization": "",
    "Source TCP/UDP Port": "",
    "Vulnerability Score": "",
    "Win Logon Fail Code": "",
    "False Positive Check": "",
    "IDS Database Version": "",
    "Post-NAT Source Port": "",
    "Source Firewall Zone": "",
    "Vulnerability CVE Id": "",
    "Business Service Name": "",
    "Destination Host Name": "",
    "IPS Event Risk Rating": "",
    "Incident Reporting IP": "",
    "Network Access Device": "",
    "Recv Packet Error Pct": "",
    "Sent Packet Error Pct": "",
    "Source Interface Name": "",
    "System Event Category": "",
    "Pre-NAT Destination IP": "",
    "Reporting Organization": "",
    "Virus Database Version": "",
    "Destination Device Port": "",
    "Event Severity Category": "",
    "IPS Event Threat Rating": ": ",
    "Post-NAT Destination IP": "",
    "Destination Organization": "",
    "Destination Service Name": "",
    "Destination TCP/UDP Port": "",
    "Network Access Device IP": "",
    "Operating System Version": "",
    "Pre-NAT Destination Port": "",
    "Destination Firewall Zone": "",
    "Palo Alto Firewall Action": "",
    "Destination Interface Name": "",
    "Extension Database Version": "",
    "Network Access Device Port": "",
    "Source Interface SNMP Index": "",
    "Firewall Session Utilization": "",
    "Post-NAT Destination Ip Port": "",
    "Previous Source TCP/UDP Port": "",
    "Command and Control Host Name": "",
    "Wireless Attack Signature Name": "",
    "Incident Trigger Attribute List": "",
    "Source Autonomous System Number": "",
    "Command and Control TCP/UDP Port": "",
    "Destination Interface SNMP Index": "",
    "Destination Autonomous System Number": "",
    "Anti-Virus Extension Database Version": ""
}

operation: Get Events Data By Query ID

Input parameters

Output

The output contains a non-dictionary value.

operation: Get Watch Lists

Input parameters

Output

The output contains the following populated JSON schema:

If you choose Get All Watch Lists or By Watch List ID as the Get Watch List Data By:

{
        "response": [
            {
                "isCaseSensitive": "",
                "naturalId": "",
                "displayName": "",
                "description": "",
                "valuePattern": "",
                "ageOut": "",
                "topGroup": "",
                "entries": [
                    {
                        "naturalId": "",
                        "firstSeen": "",
                        "count": "",
                        "triggeringRules": "",
                        "description": "",
                        "entryValue": "",
                        "expiredTime": "",
                        "ageOut": "",
                        "lastSeen": "",
                        "dataCreationType": "",
                        "custId": "",
                        "id": "",
                        "state": ""
                    }
                ],
                "dataCreationType": "",
                "valueType": "",
                "custId": "",
                "name": "",
                "id": ""
            }
        ],
        "status": ""
    }

Output schema when you choose By Watch List Entry ID as Get Watch List Data By:

{
        "response": {
            "isCaseSensitive": "",
            "naturalId": "",
            "displayName": "",
            "description": "",
            "valuePattern": "",
            "ageOut": "",
            "topGroup": "",
            "entries": [
                {
                    "naturalId": "",
                    "firstSeen": "",
                    "count": "",
                    "triggeringRules": "",
                    "description": "",
                    "entryValue": "",
                    "expiredTime": "",
                    "ageOut": "",
                    "lastSeen": "",
                    "dataCreationType": "",
                    "custId": "",
                    "id": "",
                    "state": ""
                }
            ],
            "dataCreationType": "",
            "valueType": "",
            "custId": "",
            "name": "",
            "id": ""
        },
        "status": ""
    }

This is the default output schema:

{
        "response": [
            {
                "isCaseSensitive": "",
                "naturalId": "",
                "displayName": "",
                "description": "",
                "valuePattern": "",
                "ageOut": "",
                "topGroup": "",
                "entries": [
                    {
                        "naturalId": "",
                        "firstSeen": "",
                        "count": "",
                        "triggeringRules": "",
                        "description": "",
                        "entryValue": "",
                        "expiredTime": "",
                        "ageOut": "",
                        "lastSeen": "",
                        "dataCreationType": "",
                        "custId": "",
                        "id": "",
                        "state": ""
                    }
                ],
                "dataCreationType": "",
                "valueType": "",
                "custId": "",
                "name": "",
                "id": ""
            }
        ],
        "status": ""
    }

operation: Get Watch List Entries Count

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "response": {
        "entry_count": ""
    }
}

operation: Get Watch List Entry

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "response": {
        "id": "",
        "count": "",
        "state": "",
        "ageOut": "",
        "custId": "",
        "lastSeen": "",
        "firstSeen": "",
        "naturalId": "",
        "entryValue": "",
        "description": "",
        "expiredTime": "",
        "triggeringRules": "",
        "dataCreationType": ""
    }
}

operation: Add Watch List Entries To Watch List

Input parameters

    {
        "inclusive": false,
        "count": 10,
        "custId": 1,
        "triggeringRules": "Datastore Space Warning",
        "entryValue": "PVVol_A001_A000356_POWER2",
        "ageOut": "1d",
        "lastSeen": 1613601369215,
        "firstSeen": 1613601369215,
        "disableAgeout": false,
        "dataCreationType": "USER"
    }

Output

The output contains the following populated JSON schema:

{
    "response": "",
    "status": ""
}

operation: Create Watch List

Input parameters

    {
        "description":"Servers,networkorstoragedevices",
        "displayName":"ResourceIssuesTest4",
        "type":"DyWatchList",
        "isCaseSensitive":false,
        "dataCreationType":"USER",
        "topGroup":false,
        "valuePattern":null,
        "valueType":"STRING",
        "ageOut":"1d",
        "custId":1,
        "entries":[
            {
            "inclusive":true,
            "entryValue":"PVVol_A001_A000356_5new",
            "ageOut":"1d",
            "count":1,
            "custId":1,
            "firstSeen":1612901760000,
            "lastSeen":1612901760000,
            "triggeringRules":"DatastoreSpaceWarning",
            "dataCreationType":"USER"
            }
        ]
    }

Output

The output contains the following populated JSON schema:

{
    "response": [
        {
            "isCaseSensitive": "",
            "naturalId": "",
            "displayName": "",
            "description": "",
            "valuePattern": "",
            "ageOut": "",
            "topGroup": "",
            "entries": [
                {
                    "naturalId": "",
                    "firstSeen": "",
                    "count": "",
                    "triggeringRules": "",
                    "description": "",
                    "entryValue": "",
                    "expiredTime": "",
                    "ageOut": "",
                    "lastSeen": "",
                    "dataCreationType": "",
                    "custId": "",
                    "id": "",
                    "state": ""
                }
            ],
            "dataCreationType": "",
            "valueType": "",
            "custId": "",
            "name": "",
            "id": ""
        }
    ],
    "status": ""
}

operation: Update Watch List Entry

Input parameters

    {
        "lastSeen": 1612901760002,
        "dataCreationType": "USER",
        "firstSeen": 1612901760001,
        "count": 100,
        "custId": 1,
        "triggeringRules": "Datastore Space Warning",
        "description": "Testing again",
        "id": 889400,
        "inclusive": true,
        "entryValue": "PVVol_A001_A000356_POWER23",
        "expiredTime": 1612988160001,
        "ageOut": "2d"
    }

Output

The output contains the following populated JSON schema:

{
    "response": {
        "naturalId": "",
        "firstSeen": "",
        "count": "",
        "triggeringRules": "",
        "description": "",
        "entryValue": "",
        "expiredTime": "",
        "ageOut": "",
        "lastSeen": "",
        "dataCreationType": "",
        "custId": "",
        "id": "",
        "state": ""
    },
    "status": ""
}

operation: Delete Watch List Entry

Input parameters

Output

The output contains the following populated JSON schema:

{
    "response": "",
    "status": ""
}

operation: Delete Watch List

Input parameters

Output

The output contains the following populated JSON schema:

{
    "response": "",
    "status": ""
}

operation: Create Lookup Table

Input parameters

[
    {
      "key": true,
      "name": "url",
      "type": "STRING"
    },
    {
      "key": false,
      "name": "wfCategoryID",
      "type": "LONG"
    }
  ]

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "name": "",
    "columnList": [
        {
            "key": "",
            "name": "",
            "type": ""
        }
    ],
    "description": "",
    "lastUpdated": "",
    "organizationName": ""
}

operation: Get All Lookup Table

Input parameters

Output

The output contains the following populated JSON schema:

{
    "data": [
        {
            "id": "",
            "name": "",
            "columnList": [
                {
                    "key": "",
                    "name": "",
                    "type": ""
                }
            ],
            "description": "",
            "lastUpdated": "",
            "organizationName": ""
        }
    ],
    "size": "",
    "start": "",
    "total": ""
}

operation: Delete Lookup Table

Input parameters

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "message": ""
}

operation: Import Lookup Table Data

Input parameters

    {
        "url": 1,
        "wfCategoryID": 2
    }

Output

The output contains the following populated JSON schema:

{
    "taskId": ""
}

operation: Check Import Task Status

Input parameters

Output

The output contains the following populated JSON schema:

{
    "actionResult": "",
    "id": "",
    "progress": "",
    "status": ""
}

operation: Get Lookup Table Data

Input parameters

Output

The output contains the following populated JSON schema:

{
    "data": [],
    "size": "",
    "start": "",
    "total": ""
}

operation: Update Lookup Table Data

Input parameters

    {
        "url": "www.test.com",
        "wfCategoryID": 30,
        "score": 0.50119
    }

Output

The output contains the following populated JSON schema:

{
    "response": "",
    "message": ""
}

operation: Delete Lookup Table Data

Input parameters

[
    {
      "keyColumn_1": "value",
      "keyColumn_2": "value"
    }
]  

Output

The output contains the following populated JSON schema:

{
    "status": "",
    "message": ""
}

operation: Get IP Context

Input parameters

Output

The output contains the following populated JSON schema:

{
    "contexts": [
        {
            "value": "",
            "location": {
                "city": "",
                "region": "",
                "latitude": "",
                "longitude": "",
                "countryCode": "",
                "countryName": ""
            },
            "parameter": "",
            "whoisInfo": "",
            "topEventTypes": [],
            "externalLookups": {
                "ip": "",
                "FortiGuardIOCResult": {
                    "av_cate": "",
                    "verdict": "",
                    "wf_cate": "",
                    "ioc_cate": "",
                    "ioc_tags": "",
                    "confidence": "",
                    "spam_cates": ""
                }
            },
            "topVulnerabilities": []
        }
    ]
}

operation: Get Host Context

Input parameters

Output

The output contains the following populated JSON schema:

{
    "contexts": [
        {
            "value": "",
            "hostName": "",
            "parameter": "",
            "deviceType": "",
            "importance": "",
            "externalLookups": {
                "domain": "",
                "FortiGuardIOCResult": {
                    "av_cate": "",
                    "verdict": "",
                    "wf_cate": "",
                    "ioc_cate": "",
                    "ioc_tags": "",
                    "confidence": "",
                    "spam_cates": ""
                }
            }
        }
    ]
}

operation: Get User Context

Input parameters

Output

The output contains the following populated JSON schema:

{
    "contexts": [
        {
            "value": "",
            "location": {
                "latitude": "",
                "longitude": ""
            },
            "userInfo": {
                "groups": [],
                "company": "",
                "fullName": "",
                "jobTitle": ""
            },
            "parameter": "",
            "topEventTypes": []
        }
    ]
}

Included playbooks

The Sample - Fortinet FortiSIEM - 5.2.0 playbook collection comes bundled with the Fortinet FortiSIEM connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Fortinet FortiSIEM connector.

• > FortiSIEM > Fetch
• >> FortiSIEM > Fetch Associated events for Incident
• Add Watch List Entries to Watch List
• Check Import Task Status
• Clear Incident With Reason
• Comment Incident
• Create Lookup Table
• Create Watch List
• Delete Lookup Table
• Delete Lookup Table Data
• Delete Watch List
• Delete Watch List Entry
• FortiSIEM > Ingest
• Get All Devices
• Get All Devices For Specified IP Address Range
• Get All Lookup Table
• Get Device Information
• Get Event Attributes
• Get Event Details
• Get Events Data By Query ID
• Get Events For Incident
• Get Host Context
• Get IP Context
• Get Incident Details
• Get Lookup Table Data
• Get Organization Details
• Get User Context
• Get Watch List Entries Count
• Get Watch List Entry
• Get Watch Lists
• Import Lookup Table Data
• List Incidents
• List Monitored Devices and Attributes
• List Monitored Organizations
• Run Advanced Search Query
• Search Events
• Update Incident
• Update Lookup Table Data
• Update Watch List Entry

NOTE: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.

Data Ingestion Support

Use the Data Ingestion Wizard to easily ingest data into FortiSOAR™ by pulling incidents from Fortinet FortiSIEM. Currently, Incidents in Fortinet FortiSIEM are mapped to Alerts in FortiSOAR™. For more information on the Data Ingestion Wizard, see the Connectors Guide in the FortiSOAR™ product documentation.

NOTE: To link MITRE techniques records to alerts that are being created using the Data Ingestion Wizard, use the MITRE ATT&CK Enrichment Framework and MITRE ATT&CK Threat Hunting Solution Packs.

Configure Data Ingestion

You can configure data ingestion using the Data Ingestion Wizard to seamlessly map the incoming FortiSIEM Incidents to FortiSOAR™Alerts.

The Data Ingestion Wizard helps you configure the scheduled pulling of data from FortiSIEM into FortiSOAR™. It also helps you pull some sample data from FortiSIEM using which you can define the mapping of data between FortiSIEM and FortiSOAR™. The mapping of common fields is generally already done by the Data Ingestion Wizard; users are mostly required to only map any custom fields that are added to the FortiSIEM incident.

1. To begin configuring data ingestion, click Configure Data Ingestion on the Fortinet FortiSIEM connector's Configurations page.

   Click Let's Start by fetching some data, to open the Fetch Sample Data screen.

   

   Sample data is required to create a field mapping between FortiSIEM data and FortiSOAR™. The sample data is pulled from connector actions or ingestion playbooks.

2. On the Fetch Data screen, provide the configurations required to fetch Fortinet FortiSIEM data.
   Users can choose to pull data from Fortinet FortiSIEM by selecting either the last X minutes in which the incidents have been created or updated in FortiSIEM (By Updates in Last X Minutes) or by specifying an Incident ID (By Sample Incident ID) from the Fetch Mode drop-down list. When fetching data based on By Updates in Last X Minutes, specify the number of minutes from when to retrieve incidents that were created or updated in Fortinet FortiSIEM, in the Pull Incidents Creates/Updates In Last X Minutes field. When fetching data based on By Sample Incident ID, specify the ID of the incident to retrieve from Fortinet FortiSIEM, in the Incident ID field. When fetching data based on By Updates in Last X Minutes, you can apply additional parameters such as:

   • Maximum Incidents To Pull Or Size Per Page:

     NOTE: For FortiSIEM 6.7.6 and 7.1.0: This parameter defines the maximum number of items that this operation will return, per page, in the response.

     By default, this parameter is set to 500 items.
   • Maximum Events To Pull Per Incident
   • Incident Status - Select one or more incident statuses from the Active, Manually Cleared, System Cleared, and Auto Cleared options to filter incidents.
   • Incident Category - Select one or more incident categories from the Availability, Performance, Change, Security, and Other options to filter incidents.
   • Event Type: Filters incidents based on event type
   • Other Filters: Specify parameters using which to filter the incidents retrieved from the Fortinet FortiSIEM server. For example,

         {
             "status": [0],
             "eventType": ["PH_RULE_SERVER_CPU_WARN"],
             "incidentRptIp": [10.7.12.156"]
         }

   The fetched data is used to create a mapping between the FortiSIEM data and FortiSOAR™ alerts. Once you have completed specifying the configurations, click the Fetch Data button.

   

   When configuring data ingestion for MSSP systems, if the Configure Multi-Tenant Mappings checkbox is checked, ensure that you map the organization name defined in FortiSIEM as a tenant in FortiSOAR™, in the Organization Mapping field:

   NOTE: If you have not mapped or wrongly mapped an organization, then the incident record will be created as a Self entry.

3. On the Field Mapping screen, map the fields of a FortiSIEM incident to the fields of an alert present in FortiSOAR™

   To map a field, click the key in the sample data to add the Jinja value of the field. For example, to map the attackTactic parameter of a FortiSIEM incident to the Tactics parameter of a FortiSOAR™ alert, click the Tactics field and then click the attackTactic field to populate its keys:

   

   For more information on field mapping, see the Data Ingestion chapter in the FortiSOAR™ product documentation's Connectors Guide. Once you have completed the mapping of fields, click Save Mapping & Continue.

   NOTE: The Field Mapping was updated in the release 5.1.0 of the FortiSIEM connector as follows:

   • Updated the Description field of the mapped alert record to contain additional information such as Incident Category/Sub-Category, First/Last Occurred, etc. for the incident fetched from FortiSIEM.
   • Mapped the Name field of the alert record to the "incidentTitle" key of the incident fetched from FortiSIEM.
   • Mapped the Rule field of the alert record to the "eventType" key of the incident fetched from FortiSIEM.
   • Updated the Status of the alert to be set to OPEN if the "incidentStatus" of the incident fetched from FortiSIEM is 0 (zero)

4. (Optional) Use the Scheduling screen to configure schedule-based ingestion, i.e., specify the polling frequency to FortiSIEM, so that the content gets pulled from the FortiSIEM integration into FortiSOAR™

   On the Scheduling screen, from the Do to schedule the ingestion? drop-down list, select Yes.

   In the Configure Schedule Settings section, specify the Cron expression, for example, if you want to pull data from FortiSIEM every morning at 5 a.m., click Daily, in the hour box enter 5, and in the minute box, enter 0:

   

   Once you have completed scheduling, click Save Settings & Continue.

5. The Summary screen displays a summary of the mapping done, and it also contains links to the Ingestion playbooks. Click Done to complete the data ingestion and exit the Data Ingestion Wizard.

Best Practices - Working with FortiSOAR FortiSIEM Integration

Following is a list of recommendations and suggested best practices for working with the FortiSOAR FortiSIEM integration:

• As the number of incidents in FortiSIEM might be very high, it is suggested to only pull the incidents that are of importance and need to be worked upon. For example, incidents of certain types and certain severity. The ingestion experience allows the configuration of these filters to meet the right requirements.
• It is strongly suggested to use the Maximum Events To Pull Per Incident parameter to limit and only fetch required/latest events per incident.
• It is recommended to tune the ‘Maximum Incidents To Pull Or Size Per Page’ parameter to limit the incidents fetched per iteration. Tune this parameter based on your scheduler time and the average number of incidents being pulled (with some buffer for peaks).
• Various performance improvements are done with each important release of the connector, and hence it is suggested to upgrade to the latest version of the integration. Before upgrading, we strongly recommend reading the Release notes and the connector documentation to understand the upgrade requirements/precursors/compatibility.