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.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
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
For the procedure to configure a connector, click here
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. |
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 |
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. |
The output contains the following populated JSON schema:
{
"messages": {},
"nextPage": "string"
}
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. |
The output contains the following populated JSON schema:
{
"messages": {}
}
Parameter | Description |
---|---|
Page Token | Use this parameter if fetching the next page of a previously run query. |
The output contains the following populated JSON schema:
{
"users": {},
"nextPage": "string"
}
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.
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.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
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
For the procedure to configure a connector, click here
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. |
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 |
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. |
The output contains the following populated JSON schema:
{
"messages": {},
"nextPage": "string"
}
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. |
The output contains the following populated JSON schema:
{
"messages": {}
}
Parameter | Description |
---|---|
Page Token | Use this parameter if fetching the next page of a previously run query. |
The output contains the following populated JSON schema:
{
"users": {},
"nextPage": "string"
}
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.