GSuite moduleedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Deprecated in 7.12.

This is a module for ingesting data from the different GSuite audit reports API’s.

Read the quick start to learn how to configure and run modules.


It is compatible with a subset of applications under the Google Reports API v1. As of today it supports:

GSuite Service Description

SAML api docs help

View users’ successful and failed sign-ins to SAML applications.

User Accounts api docs help

Audit actions carried out by users on their own accounts including password changes, account recovery details and 2-Step Verification enrollment.

Login api docs help

Track user sign-in activity to your domain.

Admin api docs help

View administrator activity performed within the Google Admin console.

Drive api docs help

Record user activity within Google Drive including content creation in such as Google Docs, as well as content created elsewhere that your users upload to Drive such as PDFs and Microsoft Word files.

Groups api docs help

Track changes to groups, group memberships and group messages.

Configure the moduleedit

In order for Filebeat to ingest data from the Google Reports API you must:

This module will make use of the following oauth2 scope:


Once you have downloaded your service account credentials as a JSON file, you can set up your module:

Configuration optionsedit
- module: gsuite
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: ""

Every fileset has the following configuration options:

Specifies the path to the JWT credentials file.
Email of the admin user used to access the API.
Duration of the time limit on HTTP requests made by the module. Defaults to 60s.
Duration between requests to the API. Defaults to 2h.

GSuite defaults to a 2 hour polling interval because Google reports can go from some minutes up to 3 days of delay. For more details on this, you can read more here.

Specifies the user key to fetch reports from. Defaults to all.
It will poll events up to this time period when the module starts. This is to prevent polling too many or repeated events on module restarts. Defaults to 24h.

GSuite Reports ECS fieldsedit

This is a list of GSuite Reports fields that are mapped to ECS.

GSuite Reports ECS Fields










source.ip, related.ip`,*, source.geo.*

items[],, source.user.domain


These are the common ones to all filesets.


For a description of each field in the module, see the exported fields section.