Cyware Orchestrate

Add Email Group Member

This action adds the email address of a member to an email group.

Add Item to System Blocklist/Safelist

This action adds an item to the system’s block list or safe list.

Add New Member to IP Group

This action adds a new member to an IP group.

Create Access Control Rule

This action creates an access control rule.

Create a Whitelist or Blacklist

This action creates a whitelist or a blacklist.

Create Email Group

This action creates an email group.

Create IP Group

This action creates a new IP group.

Create IP Policy

This action creates an IP policy.

Create Mail Access Rule

This action creates a mail access rule.

Create Recipient Policy

This action creates a recipient policy.

Delete Access Control Rule

This action deletes an access control rule.

Delete Email Group

This action deletes an email group.

Delete Email Group Member

This action deletes a member from an email group.

Delete IP Group

This action deletes an IP group.

Delete IP Group Member

This action deletes a member from an IP group.

Delete IP Policy

This action deletes an IP policy.

Delete Item From System Blocklist/Safelist

This action deletes an item from the system’s block list or safe list.

Delete Recipient Policy

This action deletes a recipient policy.

Get a Whitelist or Blacklist

This action retrieves 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 retrieves a list of mail access rules.

List Access Control Rules

This action lists the access control rules.

List AntiSpam Profiles

This action lists antispam profiles.

List AntiVirus Profiles

This action lists antivirus profiles.

List Content Profiles

This action lists content profiles.

List Email Group Members

This action lists all the members of an email group.

List Email Groups

This action lists email groups.

List GeoIP Groups

This action lists GeoIP groups.

List IMAP Authentication Profiles

This action lists IMAP authentication profiles.

List IP Group Members

This action lists all the members of an IP group.

List IP Groups

This action lists the IP groups.

List IP Policies

This action lists IP policies.

List IP Pool Profiles

This action lists IP pool profiles.

List IP Session Profiles

This action lists IP session profiles.

List LDAP Profiles

This action lists LDAP profiles.

List PKI Users

This action lists PKI users.

List POP3 Authentication Profiles

This action lists POP3 authentication profiles.

List RADIUS Authentication Profiles

This action lists RADIUS authentication profiles.

List Recipient Policies

This action lists recipient policies.

List Resource Profiles

This action lists resource profiles.

List SMTP Authentication Profiles

This action lists SMTP authentication profiles.

List System Blocklist/Safelist

This action lists the system’s block list or safe list.

List TLS Profiles

This action lists TLS profiles.

Modify Mail Access Rule

This action modifies a mail access rule.

Move Access Control Rule

This action moves an access control rule location in the rules list.

Move IP Policy

This action moves an IP policy location.

Move Recipient Policy

This action moves a recipient policy location in the policy list.

Remove Mail Access Rule

This action removes a mail access rule.

Replace Email Group Members

This action replaces email group members with new members.

Replace IP Group Members

This action replaces all the members of an IP group.

Update Access Control Rule

This action updates an access control rule.

Update Email Group

This action updates the comment of an email group.

Update IP Group

This action updates the comment of an IP group.

Update IP Policy

This action updates an IP policy.

Update Recipient Policy

This action updates a recipient policy.

Generic Action

This is a generic action used to make requests to any Fortinet FortiMail endpoint.

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

Timeout

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Fortinet FortiMail.

Integer

Optional

Allowed range:

15-120

Default value:

15

Verify

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.

Boolean

Optional

By default, verification is enabled.

Group Name

Enter the name of the email group where you want to add the member.

Text

Required

You can retrieve this using the action List Email Groups.

Email

Enter the email address of the new member to add to the email group.

Example:

johndoe@orgname.com

Text

Required

List Type

Enter the type of the list.

Text

Required

Allowed values:

Blocklist, Safelist

Values

Enter the item to add to the system’s safe or block list.

Text

Required

Allowed Item Types:

Email Address, Domain Name, IP Address

Group Name

Enter the name of the IP group.

Text

Required

You can retrieve this using the action List IP Groups.

Member IP Range

Enter the IP address range of the new member.

Example:

192.0.2.1 - 192.0.2.255

Text

Required

Status

Choose true to activate the access rule. If you choose false, the rule is not activated.

Boolean

Optional

By default, the rule is activated.

Sender Type

Enter the method of the SMTP client attempting to send the email message.

Integer

Optional

Allowed values:

0 for User Defined, 1 for Regular Expression, 2 for Email Group, 3 for LDAP Group, 4 for Internal, 5 for External, 6 for LDAP Verification

Default value:

0

Sender

Enter the sender of the email message.

Text

Optional

If the sender type is Email Group, enter the email group name. You can retrieve email groups using the action List Email Groups.

If the sender type is LDAP Group or LDAP Verification, enter the LDAP profile name. You can retrieve this using the action List LDAP Profiles.

Recipient Type

Enter the recipient pattern type.

Integer

Optional

Allowed values:

0 for User Defined, 1 for Regular Expression, 2 for Email Group, 3 for LDAP Group, 4 for Internal, 5 for External, 6 for LDAP Verification

Default value:

0

Recipient

Enter the recipient of the email message.

Text

Optional

If the recipient type is Email Group, enter the email group name. You can retrieve email groups using the action List Email Groups.

If the recipient type is LDAP Group or LDAP Verification, enter the LDAP profile name. You can retrieve this using the action List LDAP Profiles.

Action

Enter the delivery action for SMTP sessions matching this access control rule.

Integer

Optional

Allowed values:

1 for Safe & Relay, 2 for Relay, 3 for Reject, 4 for Discard, 5 for Safe, 6 for Receive

Default value:

1

Authentication Status

Enter the authentication status.

Integer

Optional

Allowed values:

0 for Any, 1 for Authenticated, 2 for Not Authenticated.

Default value:

0

Sender LDAP Profile

Enter the LDAP profile of the sender when the sender type is LDAP Group.

Text

Optional

You can retrieve this using the action List LDAP Profiles.

Recipient LDAP Profile

Enter the LDAP profile of the sender when the sender type is LDAP Group.

Text

Optional

You can retrieve this using the action List LDAP Profiles.

Source

Enter the source IP address and net-mask.

Text

Optional

Default value:

0.0.0.0/0

Extra Params

Enter the extra parameters to create an access control rule.

Key Value

Optional

Allowed keys:

comment, reverse_dns_pattern, reverse_dns_pattern_regex, and tls_profile

Values

Enter the values to add to the list.

Text

Required

List Type

Enter the list type.

Text

Required

Allowed values:

whitelist, blacklist

Group Name

Enter a name for the email group using alphanumeric characters only, without spaces.

Text

Required

Comment

Enter a brief comment for the email group.

Text

Optional

Group Name

Enter the IP group name using only alphanumeric characters and no spaces.

Text

Required

Comment

Enter a brief comment for the IP group.

Text

Optional

Status

Choose true to apply the policy. If you enter false, the policy is not applied.

Boolean

Optional

By default, the policy is applied.

Action

Enter the action for the policy.

Integer

Optional

Allowed values:

0 for Scan, 1 for Reject, 2 for Fail Temporarily, 4 for Proxy bypass

Default value:

0

Use SMTP Auth

Choose true to authenticate SMTP connections.

Boolean

Required

By default, this is disabled.

SMTP Different

Choose whether to reject different SMTP sender identities.

Boolean

Optional

By default, this is disabled.

SMTP Diff Identity LDAP

Choose true to verify SMTP sender identity with LDAP for authenticated email.

Boolean

Optional

By default, this is disabled.

Exclusive

Choose true to take precedence over recipient-based policy match.

Boolean

Optional

By default, this is disabled.

Destination

Enter the destination of the policy. To match all clients, enter 0.0.0.0/0.

Text

Optional

Default value:

0.0.0.0/0

Source

Enter the source of the policy. To match all clients, enter 0.0.0.0/0.

Text

Optional

Default value:

0.0.0.0/0

Extra Params

Enter the extra parameters to create an IP policy.

Example:

{"auth_type": pop3, "destination_type": ip/netmask}

Key Value

Optional

Allowed keys:

auth_type, source_type, destination_type, comment, session_profile, antispam_profile, antivirus_profile, content_profile, ip_pool_profile, auth_profile, smtp_diff_identity_ldap_profile

Sender Pattern

Enter the sender pattern.

Text

Required

Sender IP Mask

Enter the sender IP mask.

Text

Required

Extra Params

Enter the parameters to add in the form of key-value pairs.

Example:

"action_payload = {"action": 5, "sender-ip-type": 0}".

Key Value

Optional

Status

Choose true to apply the policy. If you enter false, the policy is not enabled.

Boolean

Optional

By default, the policy is applied.

Direction

Enter the mail traffic direction.

Integer

Optional

Allowed values:

1 for Inbound, 2 for Outbound

Default value is 1

Use SMTP Auth

Choose true to authenticate SMTP connections.

Boolean

Optional

By default, this is disabled.

SMTP Different

Choose true to reject different SMTP sender identities.

Boolean

Optional

By default, this is disabled.

SMTP Diff Identity LDAP

Choose true to verify SMTP sender identity with LDAP.

Boolean

Optional

By default, this is disabled.

Enable PKI

Choose true to allow email users to log in with a certificate.

Boolean

Optional

By default, this is disabled.

Certificate Validation

Choose true to require valid certificates only for authentication.

Boolean

Optional

By default, this is disabled.

Extra Params

Enter the extra parameters to create a recipient policy.

Key Value

Optional

Allowed keys:

comment, auth_type, sender_type, sender_pattern, sender_ldap_profile, sender_email_address_group, recipient_type, recipient_pattern, recipient_ldap_profile, recipient_email_address_group, antispam_profile, antivirus_profile, content_profile, resource_profile, auth_profile, smtp_diff_identity_ldap_profile, pki_profile

Access Control ID

Enter the ID of the access control rule to delete.

Integer

Required

You can retrieve this using the action List Access Control Rules.

Group Name

Enter the name of the email group to delete.

Text

Required

You can retrieve this using the action List Email Groups.

Group Name

Enter the name of the email group.

Text

Required

You can retrieve this using the action List Email Groups.

Email

Enter the email address of the member to remove from the group.

Text

Required

You can retrieve this using the action List Email Group Members.

Group Name

Enter the name of the IP group to delete.

Text

Required

You can retrieve this using the action List IP Groups.

Group Name

Enter the name of the IP group.

Text

Required

You can retrieve this using the action List IP Groups.

IP

Enter the IP address of the member to remove from the IP group.

Text

Required

You can retrieve this using the action List IP Group Members.

Policy ID

Enter the ID of the IP policy to delete.

Integer

Required

You can retrieve this using the action List IP Policies.

List Type

Enter the type of the list to delete the item from.

Text

Required

Allowed values:

Blocklist, Safelist

Values

Enter the comma-separated list of email addresses/domain names/IP addresses to remove from the system safe/block list.

List

Required

Recipient Policy ID

Enter the ID of the recipient policy to delete.

Integer

Required

You can retrieve this using the action List Recipient Policies.

List Type

Enter the list type.

Text

Required

Allowed values:

Whitelist, Blacklist

Rule Mkey Value

Enter the rule Mkey value.

Text

Required

Sorting

Enter the sorting direction.

Integer

Optional

Allowed values:

1 for enabled/sorting, 2 for disabled/no sorting

The default value is 1.

Access Control ID

Enter the ID to retrieve specific access control rule details.

Integer

Optional

Name

Enter the name to retrieve specific AntiSpam profile details.

Text

Optional

Name

Enter the name to retrieve a specific AntiVirus profile.

Text

Optional

Name

Enter the name to retrieve a specific content profile.

Text

Optional

Group Name

Enter the group name to retrieve specific group details.

Text

Required

You can retrieve this using the action List Email Groups.

Email

Enter the email address of a member to retrieve specific member details.

Text

Optional

Name

Enter the name to retrieve specific email group details.

Text

Optional

Name

Enter the name to retrieve specific GeoIP group details.

Text

Optional

Name

Enter the name to retrieve a specific imap auth profile.

Text

Optional

Group Name

Enter the name of the IP group to retrieve its members.

Text

Required

You can retrieve this using the action List IP Groups.

IP

Enter the IP address to retrieve the information about the specific IP group member.

Text

Optional

Name

Enter the name to retrieve the specific IP group.

Text

Optional

Policy ID

Enter the policy ID to retrieve specific policy details.

Text

Optional

Name

Enter the name to retrieve a specific IP pool profile.

Text

Optional

Name

Enter the name to retrieve a specific IP session profile.

Text

Optional

Name

Enter the name to retrieve a specific LDAP profile.

Text

Optional

Name

Enter the name to retrieve a specific PKI user.

Text

Optional

Name

Enter the name to retrieve a specific POP3 auth profile.

Text

Optional

Name

Enter the name to retrieve the specific RADIUS auth profile.

Text

Optional

Recipient Policy ID

Enter the ID to retrieve a specific recipient policy.

Integer

Optional

Name

Enter the name to retrieve a specific resource profile.

Text

Optional

Name

Enter the name to retrieve a specific SMTP auth profile.

Text

Optional

List Type

Enter the type of the list to retrieve.

Text

Required

Allowed values:

Blocklist, Safelist

Name

Enter the name to retrieve a specific TLS profile.

Text

Optional

Rule Mkey Value

Enter the rule Mkey value.

Integer

Required

Require Action

Enter the required action type.

Integer

Optional

Allowed values:

1 for get, 2 for create, 3 for delete, 5 for update, 14 for move

Default value is 1.

Extra Params

Enter the parameters to modify in the form of key-value pairs.

Example:

"action_payload = {"action": 5, "sender-ip-type": 0}"

Key Value

Optional

Access Control ID

Enter the ID of the access control rule to move.

Integer

Required

You can retrieve this using the action List Access Control Rules.

Action

Enter the move action.

Text

Required

Allowed values:

up, down, before, after

Reference ID

Enter the reference ID for the move action when the action is either before or after.

Integer

Optional

Policy ID

Enter the ID of the IP policy to move.

Integer

Required

You can retrieve this using the action List IP Policies.

Action

Enter the move action.

Text

Required

Allowed values:

up, down, before, after

Reference ID

Enter the reference ID of the IP policy rule when the action is before/after.

Integer

Optional

Recipient Policy ID

Enter the ID of the recipient policy to move.

Integer

Required

Action

Enter the move action.

Text

Required

Allowed values:

up, down, before, after

Reference ID

Enter the reference ID for the move action when moving before/after.

Integer

Optional

Rule Mkey Value

Enter the Mkey value of the rule.

Integer

Required

Group Name

Enter the name of the email group.

Text

Required

You can retrieve this using the action List Email Groups.

New Members

Enter the list of new email addresses to replace existing members.

List

Required

Group Name

Enter the name of the IP group.

Text

Required

You can retrieve this using the action List IP Groups.

New Members

Enter a comma-separated list of new IP addresses that you want to replace in the IP group.

List

Required

Access Control ID

Enter the ID of the access control rule to update.

Integer

Required

You can retrieve this using the action List Access Control Rules.

Status

Choose true to activate the access rule.

Boolean

Optional

By default, the access control rule is activated.

Sender Type

Enter the method of the SMTP client attempting to send the email message.

Integer

Optional

Allowed values:

0 for User Defined, 1 for Regular Expression, 2 for Email Group, 3 for LDAP Group, 4 for Internal, 5 for External, 6 for LDAP Verification

Default value:

0

Sender

Enter the sender of the email message.

Text

Optional

If the sender type is Email Group, enter the email group name. You can retrieve email groups using the action List Email Groups.

If the sender type is LDAP Group or LDAP Verification, enter the LDAP profile name. You can retrieve this using the action List LDAP Profiles.

Recipient Type

Enter the recipient pattern type.

Integer

Optional

Allowed values:

0 for User Defined, 1 for Regular Expression, 2 for Email Group, 3 for LDAP Group, 4 for Internal, 5 for External, 6 for LDAP Verification

Default value:

0

Recipient

Enter the recipient of the email message.

Text

Optional

If the recipient type is Email Group, enter the email group name. You can retrieve email groups using the action List Email Groups.

If the recipient type is LDAP Group or LDAP Verification, enter the LDAP profile name. You can retrieve this using the action List LDAP Profiles.

Action

Enter the delivery action for SMTP sessions matching this access control rule.

Integer

Optional

Allowed values:

1 for Safe & Relay, 2 for Relay, 3 for Reject, 4 for Discard, 5 for Safe, 6 for Receive

Extra Params

Enter the extra parameters to update the access control rule.

Key Value

Optional

Allowed keys:

sender_ldap_profile, recipient_ldap_profile, source_type, source, reverse_dns_pattern, reverse_dns_pattern_regex, authentication_status, tls_profile, comment

Group Name

Enter the name of the email group to update.

Text

Required

You can retrieve this using the action List Email Groups.

Comment

Enter the new comment for the email group.

Text

Required

Group Name

Enter the name of the IP group to update.

Text

Required

You can retrieve this using the action List IP Groups.

Comment

Enter the new comment for the IP group.

Text

Required

IP Policy ID

Enter the ID of the IP policy.

Integer

Required

You can retrieve this using the action List IP Policies.

Status

Choose true to apply the policy. if you enter false, the policy is not applied.

Boolean

Optional

By default, the policy is applied.

Destination

Enter the destination of the policy.

Text

Optional

To match all clients, enter 0.0.0.0/0.

Source

Enter the source of the policy.

Text

Optional

To match all clients, enter 0.0.0.0/0.

Action

Enter the action for the policy.

Integer

Optional

Allowed values:

0 for Scan, 1 for Reject, 2 for Fail Temporarily, 4 for Proxy bypass

SMTP Different

Choose whether to reject different SMTP sender identities.

Boolean

Optional

SMTP Diff Identity LDAP

Choose true to verify SMTP sender identity with LDAP for authenticated email.

Boolean

Optional

Exclusive

Choose true to take precedence over recipient-based policy match.

Boolean

Optional

Extra Params

Enter the extra parameters to update the IP policy.

Example:

{"auth_type": pop3, "destination_type": ip/netmask}

Key Value

Optional

Allowed keys:

auth_type, destination_type, source_type, comment, session_profile, antispam_profile, antivirus_profile, content_profile, ip_pool_profile, auth_profile, use_smtp_auth, smtp_diff_identity_ldap_profile

Recipient Policy ID

Enter the ID of the recipient policy to update.

Integer

Required

You can retrieve this using the action List Recipient Policies.

Status

Choose true to apply the policy.

Boolean

Optional

By default, the policy is applied.

Direction

Enter the mail traffic direction.

Integer

Optional

Allowed values:

1 for Inbound, 2 for Outbound

Use SMTP Auth

Choose true to authenticate SMTP connections.

Boolean

Optional

SMTP Different

Choose true to reject different SMTP sender identities.

Boolean

Optional

SMTP Diff Identity LDAP

Choose true to verify the SMTP sender identity with LDAP.

Boolean

Optional

Extra Params

Enter the extra parameters to update the recipient policy.

Key Value

Optional

Allowed keys:

comment, auth_type, sender_type, sender_pattern, sender_ldap_profile, sender_email_address_group, recipient_type, recipient_pattern, recipient_ldap_profile, recipient_email_address_group, antispam_profile, antivirus_profile, content_profile, resource_profile, auth_type, auth_profile, smtp_diff_identity_ldap_profile, enable_pki, pki_profile, certificate_validation

Method

Enter the HTTP methods to make the request.

Text

Required

Allowed values:

GET, PUT, POST, DELETE

Endpoint

Enter the endpoint to make the request to.

Example:

senderlistv2/system/

Text

Required

Query Params

Enter the query parameters to pass to the API.

Key Value

Optional

Payload

Enter the payload to pass to the API.

Any

Optional

Extra Fields

Enter the extra fields to pass to the API.

Key Value

Optional

Allowed keys:

payload_json, custom_output, download, retry_wait, retry_count, response_type