Skip to main content

Cyware Orchestrate

Fortinet FortiMail

App Vendor: Fortinet FortiMail

App Category: Email Gateway

Connector Version: 1.0.1

API Version: 1.0.0

About App

The Fortinetmail connector app allows security teams to integrate with the Fortinetmail enterprise application to protect against common email threats.

The Fortinet FortiMail app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Create a whitelist or blacklist

This action can be used to create a whitelist or a blacklist.

Create mail access rule

This action can be used to create a mail access rule.

Get a whitelist or blacklist

This action can be used to get a whitelist or a blacklist.

Get mail access rule details

This action can be used to get the details of a mail access rule.

Get mail access rule list

This action can be used to get a list of mail access rules.

Modify mail access rule

This action can be used to modify a mail access rule.

Remove mail access rule

This action can be used to remove a mail access rule.

Configuration Parameters

The following configuration parameters are required for the Fortinet FortiMail connector app to communicate with the Fortinet FortiMail enterprise application. The parameters can be configured by creating instances in the connector app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL

Enter the base url for api access (host or ip address).

Text

Required

Username

Enter the username.

Text

Required

Password

Enter the password.

Password

Required

Action: Get a whitelist or blacklist

This action can be used to get a whitelist or a blacklist.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

List type

Enter the list type. allowed values: - whitelist - blacklist

Text

Required

 

Action: Create mail access rule

This action can be used to create a mail access rule.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Sender pattern

Enter the sender pattern.

Text

Required

 

Sender ip mask

Enter the sender ip mask.

Text

Required

 

Parameters

Enter the parameters to add in the form of key-value pairs. for example, "action_payload = {"action": 5, "sender-ip-type": 0}".

Key Value

Optional

 

Action: Get a whitelist or blacklist

This action can be used to get a whitelist or a blacklist.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

List type

Enter the list type. allowed values: - whitelist - blacklist

Text

Required

 

Action: Get mail access rule details

This action can be used to get the details of a mail access rule.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Rule mkey value

Enter the rule mkey value.

Text

Required

 

Action: Get mail access rule list

This action can be used to get a list of mail access rules.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Sorting

Enter the sorting direction. allowed values: - 1=enabled/sorting - 2=disabled/no sorting by default, the value is set as "1".

Integer

Optional

 

Action: Modify mail access rule

This action can be used to modify a mail access rule.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Rule mkey value

Enter the rule mkey value.

Integer

Required

 

Require action

Enter the require action type. allowed values: - 1=get - 2=create - 3=delete - 5=update - 14=move

Text

Optional

 

Parameters

Enter the parameters to modify in the form of key-value pairs. for example, "action_payload = {"action": 5, "sender-ip-type": 0}".

Key Value

Optional

 

Action: Remove mail access rule

This action can be used to remove a mail access rule.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Rule mkey value

Enter the mkey value of the rule.

Integer

Required