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.
Connector Version: 3.0.0
FortiSOAR™ Version Tested on: 5.1.1-58 and 6.0.0
Fortinet FortiSIEM Version Tested on: 5.2.6 and later
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Fortinet FortiSIEM connector in version 3.0.0:
{{vars.item.incident_data.attributes.eventSeverityCat | resolveRange(vars.alerts_severity_map)}}
From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum
command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root
user to install connectors:
yum install cyops-connector-fortinet-fortisiem
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Connectors page, click the Fortinet FortiSIEM connector row, and in the Configure tab enter the required configuration details.
Parameter | Description |
---|---|
Server URL | URL of the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Username | Username used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Password | Password used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Organization | Name of the organization that you will access on the Fortinet FortiSIEM server to perform the automated operations. |
Verify SSL | Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set as True . |
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
Function | Description | Annotation and Category |
---|---|---|
Get All Devices | Retrieves a short description for all devices that are configured on the Fortinet FortiSIEM server. | get_devices Investigation |
Get All Devices For Specified IP Address Range | Retrieves a short description for devices that are configured on the Fortinet FortiSIEM server, based on the IP address range that you have specified. | get_devices Investigation |
Get Device Information | Retrieves details of a specific device that is configured on the Fortinet FortiSIEM server, based on the Device IP that you have specified. | get_devices Investigation |
List Monitored Devices and Attributes | Retrieves a list and attributes of all monitored devices that are configured on the Fortinet FortiSIEM server. | get_devices Investigation |
List Monitored Organizations | Retrieves a list and details of all monitored organizations that are configured on the Fortinet FortiSIEM server. | get_domains Investigation |
Get Organization Details | Retrieves the details of a specific organization from the Fortinet FortiSIEM server based on the organization ID that you have specified. | get_organization Investigation |
List Incidents | Retrieves a list and details of incidents from the Fortinet FortiSIEM server based on the incident ID or search criteria you have specified. | get_incidents Investigation |
Comment Incident | Adds a comment to a specific incident on the Fortinet FortiSIEM server based on the incident ID you have specified. | incident_comment Investigation |
Clear Incident With Reason | Clears an incident with the reason you have specified on the Fortinet FortiSIEM server based on the incident ID you have specified. | clear_incident Investigation |
Change Severity | Changes the severity of a specific incident severity to LOW, MEDIUM or HIGH on the Fortinet FortiSIEM server based on the incident ID you have specified. | change_incident_severity Investigation |
Change Resolution | Changes the resolution of a specific incident True Positive or False Positive on the Fortinet FortiSIEM server based on the incident ID you have specified. | change_incident_resolution Investigation |
Get Events For Incident | Retrieves all associated events for a specified incident from the Fortinet FortiSIEM server, based on the incident ID you have specified. | get_associated_events Investigation |
Run Report | Runs a report on the Fortinet FortiSIEM server, based on the report name and time range you have specified. | run_report Investigation |
Update Incident | Updates the attributes of a specific incident on the Fortinet FortiSIEM server based on the incident ID and other input parameters you have specified. | update_incident Investigation |
Get Event Details | Retrieves details of a specific event from the Fortinet FortiSIEM server based on the event ID you have specified. | get_event_details Investigation |
None.
The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@id": "",
"@name": ""
},
"discoverTime": "",
"unmanaged": "",
"accessIp": "",
"approved": "",
"discoverMethod": "",
"name": "",
"deviceType": {
"version": "",
"vendor": "",
"accessProtocols": "",
"jobWeight": "",
"model": ""
},
"creationMethod": "",
"version": "",
"updateMethod": ""
}
]
}
}
Parameter | Description |
---|---|
Include IP SET | Value of IP addresses based on which you want for retrieve device information from the Fortinet FortiSIEM server. You must provide the value of this field as a range or in the .csv format. For example, enter, 192.168.20.1-192.168.20.100 |
Exclude IP SET | (Optional) Value of the range of IP addresses that you want to exclude from this search operation. You must provide the value of this field as a range or in the .csv format. |
The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@id": "",
"@name": ""
},
"discoverTime": "",
"unmanaged": "",
"accessIp": "",
"approved": "",
"discoverMethod": "",
"name": "",
"deviceType": {
"version": "",
"vendor": "",
"accessProtocols": "",
"jobWeight": "",
"model": ""
},
"creationMethod": "",
"version": "",
"updateMethod": ""
}
]
}
}
Parameter | Description |
---|---|
Device IP | IP address of the device for which you want to retrieve details from the Fortinet FortiSIEM server. |
Organization | (Optional) Name of the organization for which you want to retrieve details of the device from the Fortinet FortiSIEM server. |
Output
The output contains the following populated JSON schema:
{
"device": {
"name": "",
"raidGroups": "",
"description": "",
"sanControllerPorts": "",
"storages": "",
"luns": "",
"eventParserList": "",
"systemUpTime": "",
"components": "",
"unmanaged": "",
"processors": "",
"applications": "",
"accessIp": "",
"approved": "",
"softwarePatches": "",
"ipToHostNames": "",
"organization": {
"@name": "",
"@id": ""
},
"storageGroups": "",
"softwareServices": "",
"interfaces": {
"networkinterface": {
"isTrunk": "",
"ipv4Addr": "",
"ipv4Mask": "",
"description": "",
"name": "",
"type": "",
"macAddr": "",
"isCritical": "",
"macIsVirtual": "",
"ipv4IsVirtual": "",
"inSpeed": "",
"speed": "",
"snmpIndex": "",
"isMonitor": "",
"adminStatus": "",
"outSpeed": "",
"operStatus": "",
"isWAN": ""
}
},
"deviceType": {
"model": "",
"version": "",
"category": "",
"jobWeight": "",
"vendor": ""
},
"updateMethod": "",
"discoverTime": "",
"discoverMethod": "",
"creationMethod": ""
}
}
None.
The output contains the following populated JSON schema:
{
"monitoredDevices": {
"eventPullingDevices": "",
"perfMonDevices": {
"device": {
"deviceName": "",
"monitors": {
"monitor": [
{
"method": "",
"category": ""
}
]
},
"deviceType": "",
"organization": "",
"accessIp": ""
}
}
}
}
None.
The output contains the following populated JSON schema:
{
"disabled": "",
"@lastModified": "",
"name": "",
"initialized": "",
"collectors": {
"collector": []
},
"@xmlId": "",
"custProperties": "",
"@ownerId": "",
"@id": "",
"domainId": "",
"@entityVersion": "",
"@custId": "",
"@creationTime": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident based on which you want to retrieve incidents from the Fortinet FortiSIEM server. Important: If you enter the incident ID then all other parameters specified for this action get ignored. |
Search | Search criteria based on which you want to retrieve incidents from the Fortinet FortiSIEM server. You can choose from the following options: Incident Status, Severity, Host, IP, or Organization. By default, this option is set as Incident Status. |
Search Value | Value of the search criteria based on what you have selected in the Search parameter. For example, in the case of Incident Status, you must select the status of the incident (Active or Cleared) based on which you want to retrieve incidents from the Fortinet FortiSIEM server. OR For example, if you select Host, then you must specify the hostname based on which you want to retrieve incidents from the Fortinet FortiSIEM server. Note: From version 2.2.0 of the Fortinet FortiSIEM connector, if you have selected Organization from the Search field, then you can either explicitly add the organization name or use a jinja expression to add the value of the Organization. |
Time Selection | (Optional) Specify the time for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. By default, this is set as Relative Time. If you select Absolute Time, then you must specify the time range, for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server, in the From and To fields using the calendar tool. If you select Relative Time, then you have to specify the time duration for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. For example, if you choose Hours from the Relative Time drop-down list and provide the value 2 in the Last field, then this operation retrieves the list of incidents that have occurred in the last 2 hours from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"events": [
{
"attributes": {},
"id": "",
"receiveTime": "",
"nid": "",
"dataStr": "",
"index": "",
"eventType": "",
"custId": ""
}
],
"@queryId": "",
"@totalCount": "",
"@errorCode": "",
"@start": ""
}
Parameter | Description |
---|---|
Organization ID | ID of the organization whose details you want to retrieve from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"@custId": "",
"@creationTime": "",
"@entityVersion": "",
"@id": "",
"@lastModified": "",
"name": "",
"domainId": "",
"@xmlId": "",
"@ownerId": "",
"initialized": "",
"disabled": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident in which you want to add the comment on the Fortinet FortiSIEM server. |
Comment Text | Text of the comment that you want to add to the specified incident on the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"message": "",
"incident_id": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident that you want to clear from the Fortinet FortiSIEM server. |
Reason | Text of the reason that you want to provide which clearing the specified incident from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"message": "",
"incident_id": []
}
Parameter | Description |
---|---|
Incident ID | ID of the incident whose severity you want to update on the Fortinet FortiSIEM server. |
Incident Severity | Severity that you want to set for the specified incident on the Fortinet FortiSIEM server. You can choose from the following options: HIGH, MEDIUM, or LOW. |
The output contains the following populated JSON schema:
{
"incident_id": [],
"message": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident whose resolution you want to update on the Fortinet FortiSIEM server. |
Incident Resolution | Resolution that you want to set for the specified incident on the Fortinet FortiSIEM server. You can choose between True Positive or False Positive. |
The output contains the following populated JSON schema:
{
"incident_id": [],
"message": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident for which you want to retrieve all associated events from the Fortinet FortiSIEM server. |
Page Size |
Number of objects that you want this operation to return in the response. |
Page Number | Page number from which you want to retrieve records. By default, this is set as 0. |
The output contains the following populated JSON schema:
{
"event_ids": "",
"event_details": [
[
{
"dataStr": "",
"index": "",
"custId": "",
"receiveTime": "",
"attributes": {
"eventSeverity": "",
"relayDevIpAddr": "",
"reptDevName": "",
"reptModel": "",
"eventParsedOk": "",
"phRecvTime": "",
"count": "",
"hostIpAddr": "",
"hostName": "",
"reptDevIpAddr": "",
"parserName": "",
"customer": "",
"eventId": "",
"eventRuleTrigger": "",
"procName": "",
"collectorId": "",
"eventName": "",
"eventType": "",
"rawEventMsg": "",
"phEventCategory": "",
"eventSeverityCat": "",
"reptVendor": ""
},
"nid": "",
"id": "",
"eventType": ""
}
]
]
}
Parameter | Description |
---|---|
Report Name | Name of the report that you want to run on the Fortinet FortiSIEM server. |
Report Time Range | (Optional) Specify the time duration for which you want to search for reports that you want to run on the Fortinet FortiSIEM server. By default, this is set as Relative Time. If you select Absolute Time, then you must specify the time range, for which you want to search for reports that you want to run on the Fortinet FortiSIEM server, in the From and To fields using the calendar tool. If you select Relative Time, then you have to specify the time duration for which you want to search for reports that you want to run on the Fortinet FortiSIEM server. For example, if you choose Hours from the Relative Time drop-down list and provide the value 2 in the Last field, then this operation searches for reports that are created in the last 2 hours on the Fortinet FortiSIEM server. |
No output schema is available at this time.
Parameter | Description |
---|---|
Incident ID | ID of the incident that you want to update on the Fortinet FortiSIEM server. |
Comment Text | Text of the comment that you want to add to the specified incident on the Fortinet FortiSIEM server. |
Incident Status | Status of the incident that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket Type | Type of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket ID | ID of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket State | State of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Assigned User | External assigned that you want to update in the specified incident on the Fortinet FortiSIEM server. |
The output contains a non-dictionary value.
Parameter | Description |
---|---|
Event ID | ID of the event whose details you want to retrieve from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"dataStr": "",
"index": "",
"custId": "",
"receiveTime": "",
"attributes": {
"eventSeverity": "",
"relayDevIpAddr": "",
"reptDevName": "",
"reptModel": "",
"eventParsedOk": "",
"phRecvTime": "",
"count": "",
"hostIpAddr": "",
"hostName": "",
"reptDevIpAddr": "",
"parserName": "",
"customer": "",
"eventId": "",
"eventRuleTrigger": "",
"procName": "",
"collectorId": "",
"eventName": "",
"eventType": "",
"rawEventMsg": "",
"phEventCategory": "",
"eventSeverityCat": "",
"reptVendor": ""
},
"nid": "",
"id": "",
"eventType": ""
}
The Sample - Fortinet FortiSIEM - 3.0.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.
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.
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.
Connector Version: 3.0.0
FortiSOAR™ Version Tested on: 5.1.1-58 and 6.0.0
Fortinet FortiSIEM Version Tested on: 5.2.6 and later
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Fortinet FortiSIEM connector in version 3.0.0:
{{vars.item.incident_data.attributes.eventSeverityCat | resolveRange(vars.alerts_severity_map)}}
From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum
command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root
user to install connectors:
yum install cyops-connector-fortinet-fortisiem
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Connectors page, click the Fortinet FortiSIEM connector row, and in the Configure tab enter the required configuration details.
Parameter | Description |
---|---|
Server URL | URL of the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Username | Username used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Password | Password used to access the Fortinet FortiSIEM server to which you will connect and perform the automated operations. |
Organization | Name of the organization that you will access on the Fortinet FortiSIEM server to perform the automated operations. |
Verify SSL | Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set as True . |
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
Function | Description | Annotation and Category |
---|---|---|
Get All Devices | Retrieves a short description for all devices that are configured on the Fortinet FortiSIEM server. | get_devices Investigation |
Get All Devices For Specified IP Address Range | Retrieves a short description for devices that are configured on the Fortinet FortiSIEM server, based on the IP address range that you have specified. | get_devices Investigation |
Get Device Information | Retrieves details of a specific device that is configured on the Fortinet FortiSIEM server, based on the Device IP that you have specified. | get_devices Investigation |
List Monitored Devices and Attributes | Retrieves a list and attributes of all monitored devices that are configured on the Fortinet FortiSIEM server. | get_devices Investigation |
List Monitored Organizations | Retrieves a list and details of all monitored organizations that are configured on the Fortinet FortiSIEM server. | get_domains Investigation |
Get Organization Details | Retrieves the details of a specific organization from the Fortinet FortiSIEM server based on the organization ID that you have specified. | get_organization Investigation |
List Incidents | Retrieves a list and details of incidents from the Fortinet FortiSIEM server based on the incident ID or search criteria you have specified. | get_incidents Investigation |
Comment Incident | Adds a comment to a specific incident on the Fortinet FortiSIEM server based on the incident ID you have specified. | incident_comment Investigation |
Clear Incident With Reason | Clears an incident with the reason you have specified on the Fortinet FortiSIEM server based on the incident ID you have specified. | clear_incident Investigation |
Change Severity | Changes the severity of a specific incident severity to LOW, MEDIUM or HIGH on the Fortinet FortiSIEM server based on the incident ID you have specified. | change_incident_severity Investigation |
Change Resolution | Changes the resolution of a specific incident True Positive or False Positive on the Fortinet FortiSIEM server based on the incident ID you have specified. | change_incident_resolution Investigation |
Get Events For Incident | Retrieves all associated events for a specified incident from the Fortinet FortiSIEM server, based on the incident ID you have specified. | get_associated_events Investigation |
Run Report | Runs a report on the Fortinet FortiSIEM server, based on the report name and time range you have specified. | run_report Investigation |
Update Incident | Updates the attributes of a specific incident on the Fortinet FortiSIEM server based on the incident ID and other input parameters you have specified. | update_incident Investigation |
Get Event Details | Retrieves details of a specific event from the Fortinet FortiSIEM server based on the event ID you have specified. | get_event_details Investigation |
None.
The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@id": "",
"@name": ""
},
"discoverTime": "",
"unmanaged": "",
"accessIp": "",
"approved": "",
"discoverMethod": "",
"name": "",
"deviceType": {
"version": "",
"vendor": "",
"accessProtocols": "",
"jobWeight": "",
"model": ""
},
"creationMethod": "",
"version": "",
"updateMethod": ""
}
]
}
}
Parameter | Description |
---|---|
Include IP SET | Value of IP addresses based on which you want for retrieve device information from the Fortinet FortiSIEM server. You must provide the value of this field as a range or in the .csv format. For example, enter, 192.168.20.1-192.168.20.100 |
Exclude IP SET | (Optional) Value of the range of IP addresses that you want to exclude from this search operation. You must provide the value of this field as a range or in the .csv format. |
The output contains the following populated JSON schema:
{
"devices": {
"device": [
{
"organization": {
"@id": "",
"@name": ""
},
"discoverTime": "",
"unmanaged": "",
"accessIp": "",
"approved": "",
"discoverMethod": "",
"name": "",
"deviceType": {
"version": "",
"vendor": "",
"accessProtocols": "",
"jobWeight": "",
"model": ""
},
"creationMethod": "",
"version": "",
"updateMethod": ""
}
]
}
}
Parameter | Description |
---|---|
Device IP | IP address of the device for which you want to retrieve details from the Fortinet FortiSIEM server. |
Organization | (Optional) Name of the organization for which you want to retrieve details of the device from the Fortinet FortiSIEM server. |
Output
The output contains the following populated JSON schema:
{
"device": {
"name": "",
"raidGroups": "",
"description": "",
"sanControllerPorts": "",
"storages": "",
"luns": "",
"eventParserList": "",
"systemUpTime": "",
"components": "",
"unmanaged": "",
"processors": "",
"applications": "",
"accessIp": "",
"approved": "",
"softwarePatches": "",
"ipToHostNames": "",
"organization": {
"@name": "",
"@id": ""
},
"storageGroups": "",
"softwareServices": "",
"interfaces": {
"networkinterface": {
"isTrunk": "",
"ipv4Addr": "",
"ipv4Mask": "",
"description": "",
"name": "",
"type": "",
"macAddr": "",
"isCritical": "",
"macIsVirtual": "",
"ipv4IsVirtual": "",
"inSpeed": "",
"speed": "",
"snmpIndex": "",
"isMonitor": "",
"adminStatus": "",
"outSpeed": "",
"operStatus": "",
"isWAN": ""
}
},
"deviceType": {
"model": "",
"version": "",
"category": "",
"jobWeight": "",
"vendor": ""
},
"updateMethod": "",
"discoverTime": "",
"discoverMethod": "",
"creationMethod": ""
}
}
None.
The output contains the following populated JSON schema:
{
"monitoredDevices": {
"eventPullingDevices": "",
"perfMonDevices": {
"device": {
"deviceName": "",
"monitors": {
"monitor": [
{
"method": "",
"category": ""
}
]
},
"deviceType": "",
"organization": "",
"accessIp": ""
}
}
}
}
None.
The output contains the following populated JSON schema:
{
"disabled": "",
"@lastModified": "",
"name": "",
"initialized": "",
"collectors": {
"collector": []
},
"@xmlId": "",
"custProperties": "",
"@ownerId": "",
"@id": "",
"domainId": "",
"@entityVersion": "",
"@custId": "",
"@creationTime": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident based on which you want to retrieve incidents from the Fortinet FortiSIEM server. Important: If you enter the incident ID then all other parameters specified for this action get ignored. |
Search | Search criteria based on which you want to retrieve incidents from the Fortinet FortiSIEM server. You can choose from the following options: Incident Status, Severity, Host, IP, or Organization. By default, this option is set as Incident Status. |
Search Value | Value of the search criteria based on what you have selected in the Search parameter. For example, in the case of Incident Status, you must select the status of the incident (Active or Cleared) based on which you want to retrieve incidents from the Fortinet FortiSIEM server. OR For example, if you select Host, then you must specify the hostname based on which you want to retrieve incidents from the Fortinet FortiSIEM server. Note: From version 2.2.0 of the Fortinet FortiSIEM connector, if you have selected Organization from the Search field, then you can either explicitly add the organization name or use a jinja expression to add the value of the Organization. |
Time Selection | (Optional) Specify the time for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. By default, this is set as Relative Time. If you select Absolute Time, then you must specify the time range, for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server, in the From and To fields using the calendar tool. If you select Relative Time, then you have to specify the time duration for which you want to retrieve the list of incidents from the Fortinet FortiSIEM server. For example, if you choose Hours from the Relative Time drop-down list and provide the value 2 in the Last field, then this operation retrieves the list of incidents that have occurred in the last 2 hours from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"events": [
{
"attributes": {},
"id": "",
"receiveTime": "",
"nid": "",
"dataStr": "",
"index": "",
"eventType": "",
"custId": ""
}
],
"@queryId": "",
"@totalCount": "",
"@errorCode": "",
"@start": ""
}
Parameter | Description |
---|---|
Organization ID | ID of the organization whose details you want to retrieve from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"@custId": "",
"@creationTime": "",
"@entityVersion": "",
"@id": "",
"@lastModified": "",
"name": "",
"domainId": "",
"@xmlId": "",
"@ownerId": "",
"initialized": "",
"disabled": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident in which you want to add the comment on the Fortinet FortiSIEM server. |
Comment Text | Text of the comment that you want to add to the specified incident on the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"message": "",
"incident_id": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident that you want to clear from the Fortinet FortiSIEM server. |
Reason | Text of the reason that you want to provide which clearing the specified incident from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"message": "",
"incident_id": []
}
Parameter | Description |
---|---|
Incident ID | ID of the incident whose severity you want to update on the Fortinet FortiSIEM server. |
Incident Severity | Severity that you want to set for the specified incident on the Fortinet FortiSIEM server. You can choose from the following options: HIGH, MEDIUM, or LOW. |
The output contains the following populated JSON schema:
{
"incident_id": [],
"message": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident whose resolution you want to update on the Fortinet FortiSIEM server. |
Incident Resolution | Resolution that you want to set for the specified incident on the Fortinet FortiSIEM server. You can choose between True Positive or False Positive. |
The output contains the following populated JSON schema:
{
"incident_id": [],
"message": ""
}
Parameter | Description |
---|---|
Incident ID | ID of the incident for which you want to retrieve all associated events from the Fortinet FortiSIEM server. |
Page Size |
Number of objects that you want this operation to return in the response. |
Page Number | Page number from which you want to retrieve records. By default, this is set as 0. |
The output contains the following populated JSON schema:
{
"event_ids": "",
"event_details": [
[
{
"dataStr": "",
"index": "",
"custId": "",
"receiveTime": "",
"attributes": {
"eventSeverity": "",
"relayDevIpAddr": "",
"reptDevName": "",
"reptModel": "",
"eventParsedOk": "",
"phRecvTime": "",
"count": "",
"hostIpAddr": "",
"hostName": "",
"reptDevIpAddr": "",
"parserName": "",
"customer": "",
"eventId": "",
"eventRuleTrigger": "",
"procName": "",
"collectorId": "",
"eventName": "",
"eventType": "",
"rawEventMsg": "",
"phEventCategory": "",
"eventSeverityCat": "",
"reptVendor": ""
},
"nid": "",
"id": "",
"eventType": ""
}
]
]
}
Parameter | Description |
---|---|
Report Name | Name of the report that you want to run on the Fortinet FortiSIEM server. |
Report Time Range | (Optional) Specify the time duration for which you want to search for reports that you want to run on the Fortinet FortiSIEM server. By default, this is set as Relative Time. If you select Absolute Time, then you must specify the time range, for which you want to search for reports that you want to run on the Fortinet FortiSIEM server, in the From and To fields using the calendar tool. If you select Relative Time, then you have to specify the time duration for which you want to search for reports that you want to run on the Fortinet FortiSIEM server. For example, if you choose Hours from the Relative Time drop-down list and provide the value 2 in the Last field, then this operation searches for reports that are created in the last 2 hours on the Fortinet FortiSIEM server. |
No output schema is available at this time.
Parameter | Description |
---|---|
Incident ID | ID of the incident that you want to update on the Fortinet FortiSIEM server. |
Comment Text | Text of the comment that you want to add to the specified incident on the Fortinet FortiSIEM server. |
Incident Status | Status of the incident that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket Type | Type of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket ID | ID of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Ticket State | State of the external ticket that you want to update in the specified incident on the Fortinet FortiSIEM server. |
External Assigned User | External assigned that you want to update in the specified incident on the Fortinet FortiSIEM server. |
The output contains a non-dictionary value.
Parameter | Description |
---|---|
Event ID | ID of the event whose details you want to retrieve from the Fortinet FortiSIEM server. |
The output contains the following populated JSON schema:
{
"dataStr": "",
"index": "",
"custId": "",
"receiveTime": "",
"attributes": {
"eventSeverity": "",
"relayDevIpAddr": "",
"reptDevName": "",
"reptModel": "",
"eventParsedOk": "",
"phRecvTime": "",
"count": "",
"hostIpAddr": "",
"hostName": "",
"reptDevIpAddr": "",
"parserName": "",
"customer": "",
"eventId": "",
"eventRuleTrigger": "",
"procName": "",
"collectorId": "",
"eventName": "",
"eventType": "",
"rawEventMsg": "",
"phEventCategory": "",
"eventSeverityCat": "",
"reptVendor": ""
},
"nid": "",
"id": "",
"eventType": ""
}
The Sample - Fortinet FortiSIEM - 3.0.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.
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.