Fortinet Document Library

Version:


Table of Contents

GSuite for GMail

1.0.0
Copy Link

About the connector

G Suite comprises Gmail, Hangouts, Calendar, and Google+ for communication; Drive for storage; Docs, Sheets, Slides, Forms, and Sites for collaboration; and an Admin panel and Vault for managing users and the services.

This document provides information about the GSuite for Gmail connector, which facilitates automated interactions with GSuite for Gmail using FortiSOAR™ playbooks. Add the GSuite for Gmail connector as a step in FortiSOAR™ playbooks and perform automated operations, such as searching for emails using GSuite for Gmail, or deleting emails using GSuite for Gmail.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-gmail

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the email address of the admin account for GSuite for Gmail and the service account details in the JSON format.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the GSuite for Gmail connector and click Configure to configure the following parameters:

Parameter Description
Admin Account Email Address Email address of the Admin Account for GSuite for Gmail.
Service Account JSON contents Service Account details in the JSON format.

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™ release 4.10.0 and onwards:

Function Description Annotation and Category
Search for Emails Search a user's emails based on a provided query. search_emails
Investigation
Delete Emails Delete email messages from a user's inbox. delete_messages
Investigation
List Users Lists the users in this domain. list_users
Investigation

operation: Search for Emails

Input parameters

Parameter Description
Query Search query. This can use specifiers such as 'from:', 'subject:', etc.
Page Token Use this parameter if fetching the next page of a previously run query.
Email Address Email address of the user whose emails should be searched.

Output

The output contains the following populated JSON schema:
{
     "messages": {},
     "nextPage": "string"
}

operation: Delete Emails

Input parameters

Parameter Description
Email Address Email address of the user to whom the emails belong.
Email IDs A semicolon-delimited list of email message IDs to be deleted.

Output

The output contains the following populated JSON schema:
{
     "messages": {}
}

operation: List Users

Input parameters

Parameter Description
Page Token Use this parameter if fetching the next page of a previously run query.

Output

The output contains the following populated JSON schema:
{
     "users": {},
     "nextPage": "string"
}

Included playbooks

The Sample - GSuite for Gmail - 1.0.0 playbook collection comes bundled with the GSuite for Gmail 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 GSuite for Gmail connector.

  • Delete Emails
  • List Users
  • Search for Emails

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.

About the connector

G Suite comprises Gmail, Hangouts, Calendar, and Google+ for communication; Drive for storage; Docs, Sheets, Slides, Forms, and Sites for collaboration; and an Admin panel and Vault for managing users and the services.

This document provides information about the GSuite for Gmail connector, which facilitates automated interactions with GSuite for Gmail using FortiSOAR™ playbooks. Add the GSuite for Gmail connector as a step in FortiSOAR™ playbooks and perform automated operations, such as searching for emails using GSuite for Gmail, or deleting emails using GSuite for Gmail.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-gmail

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the GSuite for Gmail connector and click Configure to configure the following parameters:

Parameter Description
Admin Account Email Address Email address of the Admin Account for GSuite for Gmail.
Service Account JSON contents Service Account details in the JSON format.

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™ release 4.10.0 and onwards:

Function Description Annotation and Category
Search for Emails Search a user's emails based on a provided query. search_emails
Investigation
Delete Emails Delete email messages from a user's inbox. delete_messages
Investigation
List Users Lists the users in this domain. list_users
Investigation

operation: Search for Emails

Input parameters

Parameter Description
Query Search query. This can use specifiers such as 'from:', 'subject:', etc.
Page Token Use this parameter if fetching the next page of a previously run query.
Email Address Email address of the user whose emails should be searched.

Output

The output contains the following populated JSON schema:
{
     "messages": {},
     "nextPage": "string"
}

operation: Delete Emails

Input parameters

Parameter Description
Email Address Email address of the user to whom the emails belong.
Email IDs A semicolon-delimited list of email message IDs to be deleted.

Output

The output contains the following populated JSON schema:
{
     "messages": {}
}

operation: List Users

Input parameters

Parameter Description
Page Token Use this parameter if fetching the next page of a previously run query.

Output

The output contains the following populated JSON schema:
{
     "users": {},
     "nextPage": "string"
}

Included playbooks

The Sample - GSuite for Gmail - 1.0.0 playbook collection comes bundled with the GSuite for Gmail 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 GSuite for Gmail 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.