About the connector
Google BigQuery is a cloud-based big data analytics web service for processing very large read-only data sets.
This document provides information about the Google BigQuery connector, which facilitates automated interactions with Google BigQuery using FortiSOAR™ playbooks. Add the Google BigQuery connector as a step in FortiSOAR™ playbooks and perform automated operations, such as running a query to fetch details from Google cloud server, or retrieving the list of tables available in Google cloud server using Google BigQuery.
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-google-bigquery
For the detailed procedure to install a connector, click here
Prerequisites to configuring the connector
- You must provide the service account JSON file for Google BigQuery Authentication.
- 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 Google BigQuery connector and click Configure to configure the following parameters:
| Parameter |
Description |
| Upload Service Account JSON File |
Provide Service file for Google BigQuery Authentication. |
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 |
| Run a Query |
Run SQL query to fetch details from Google cloud server. |
run_query
Investigation |
| List Tables |
Retrieves the list of tables available in Google cloud server using Google BigQuery. |
list_tables
Miscellaneous |
operation: Run a Query
Input parameters
| Parameter |
Description |
| query |
Provide the SQL query to be run and fetch details from Google cloud server. |
Output
The output contains the following populated JSON schema:
{
"query_result": {}
}
operation: List Tables
Input parameters
None.
Output
The output contains the following populated JSON schema:
{
"bigquery_tables": {}
}
Included playbooks
The Sample - Google BigQuery - 1.0.0 playbook collection comes bundled with the Google BigQuery 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 Google BigQuery 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.
