Fortinet white logo
Fortinet white logo

Fortinet FortiGuard Outbreak

1.0.1

Fortinet FortiGuard Outbreak v1.0.1

About the connector

Fortinet FortiGuard Outbreak provides key information about on-going cybersecurity attacks with significant ramifications affecting numerous companies, organizations, and industries. This connector facilitates automated operations to fetch Indicators of Compromise (IOCs) of outbreak alert.

This document provides information about the Fortinet FortiGuard Outbreak Connector, which facilitates automated interactions, with a Fortinet FortiGuard Outbreak server using FortiSOAR™ playbooks. Add the Fortinet FortiGuard Outbreak Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiGuard Outbreak.

Version information

Connector Version: 1.0.1

FortiSOAR™ Version Tested on: 7.4.3-3294

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.0.1

Following enhancements have been made to the Fortinet FortiGuard Outbreak connector in version 1.0.1:

  • OpenSSL v3.0.7 has deprecated the package requests-pkcs12 version which was being used. Upgraded the package version to a compatible OpenSSL version.

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 yum command as a root user to install the connector:

yum install cyops-connector-fortinet-fortiguard-outbreak

Prerequisites to configuring the connector

  • The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiGuard Outbreak server.

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet FortiGuard Outbreak connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server Name URL of the FortiGuard Threat Intelligence API server to which you will connect and perform automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True.

Actions supported by the connector

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

Function Description Annotation and Category
List Outbreak Alert Tags Retrieves a list of outbreak alert tags from FortiGuard list_outbreak_alert_tags
Investigation
Get Outbreak Alert IOCs Retrieves a list of outbreak alert IOCs from FortiGuard based on the tag name that you have specified. get_outbreak_alert_iocs
Investigation

operation: List Outbreak Alert Tags

Input parameters

None.

Output

The output contains the following populated JSON schema:

[
    {
        "tag": ""
    }
]

operation: Get Outbreak Alert IOCs

Input parameters

Parameter Description
Outbreak Alert Tag Name Specify the tag name of the outbreak alert to retrieve its associated IOCs from FortiGuard server.

Output

The output contains the following populated JSON schema:

[
    {
        "ioc": "",
        "type": "",
        "active": ""
    }
]

Included playbooks

The Sample - Fortinet FortiGuard Outbreak - 1.0.1 playbook collection comes bundled with the Fortinet FortiGuard Outbreak connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Fortinet FortiGuard Outbreak connector.

  • Get Outbreak Alert IOCs
  • List Outbreak Alert Tags

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 connector upgrade and delete.

Previous
Next

Fortinet FortiGuard Outbreak v1.0.1

About the connector

Fortinet FortiGuard Outbreak provides key information about on-going cybersecurity attacks with significant ramifications affecting numerous companies, organizations, and industries. This connector facilitates automated operations to fetch Indicators of Compromise (IOCs) of outbreak alert.

This document provides information about the Fortinet FortiGuard Outbreak Connector, which facilitates automated interactions, with a Fortinet FortiGuard Outbreak server using FortiSOAR™ playbooks. Add the Fortinet FortiGuard Outbreak Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiGuard Outbreak.

Version information

Connector Version: 1.0.1

FortiSOAR™ Version Tested on: 7.4.3-3294

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.0.1

Following enhancements have been made to the Fortinet FortiGuard Outbreak connector in version 1.0.1:

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 yum command as a root user to install the connector:

yum install cyops-connector-fortinet-fortiguard-outbreak

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet FortiGuard Outbreak connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server Name URL of the FortiGuard Threat Intelligence API server to which you will connect and perform automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True.

Actions supported by the connector

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

Function Description Annotation and Category
List Outbreak Alert Tags Retrieves a list of outbreak alert tags from FortiGuard list_outbreak_alert_tags
Investigation
Get Outbreak Alert IOCs Retrieves a list of outbreak alert IOCs from FortiGuard based on the tag name that you have specified. get_outbreak_alert_iocs
Investigation

operation: List Outbreak Alert Tags

Input parameters

None.

Output

The output contains the following populated JSON schema:

[
    {
        "tag": ""
    }
]

operation: Get Outbreak Alert IOCs

Input parameters

Parameter Description
Outbreak Alert Tag Name Specify the tag name of the outbreak alert to retrieve its associated IOCs from FortiGuard server.

Output

The output contains the following populated JSON schema:

[
    {
        "ioc": "",
        "type": "",
        "active": ""
    }
]

Included playbooks

The Sample - Fortinet FortiGuard Outbreak - 1.0.1 playbook collection comes bundled with the Fortinet FortiGuard Outbreak connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Fortinet FortiGuard Outbreak 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 connector upgrade and delete.

Previous
Next