% This file is generated! See filebeat/scripts/mage/docs.go

Google Workspace module [filebeat-module-google_workspace]

:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.

::::{dropdown} Learn more {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of {{beats}} and {{agent}}.

::::

:::::

This is a module for ingesting data from the different Google Workspace audit reports APIs.

::::{tip} Read the quick start to learn how to configure and run modules. ::::

Compatibility [_compatibility_13]

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

| Google Workspace 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 module [_configure_the_module]

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

Have an administrator account, as described here.
Set up a ServiceAccount using the administrator account.
Set up access to the Admin SDK API for the ServiceAccount.
Enable Domain-Wide Delegation for your ServiceAccount.

This module will make use of the following oauth2 scope:

https://www.googleapis.com/auth/admin.reports.audit.readonly

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

Configuration options [_configuration_options_42]

yaml

- module: google_workspace
  saml:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"
  user_accounts:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"
  login:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"
  admin:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"
  drive:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"
  groups:
    enabled: true
    var.jwt_file: "./credentials_file.json"
    var.delegated_account: "[email protected]"

Every fileset has the following configuration options:

var.jwt_file : Specifies the path to the JWT credentials file.

var.delegated_account : Email of the admin user used to access the API.

var.http_client_timeout : Duration of the time limit on HTTP requests made by the module. Defaults to 60s.

var.interval : Duration between requests to the API. Defaults to 2h.

::::{note} Google Workspace 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. ::::

var.user_key : Specifies the user key to fetch reports from. Defaults to all.

var.initial_interval : 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.

Google Workspace Reports ECS fields [_google_workspace_reports_ecs_fields]

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

| Google Workspace Reports | ECS Fields | | --- | --- | --- | | items[].id.time | @timestamp | | items[].id.uniqueQualifier | event.id | | items[].id.applicationName | event.provider | | items[].events[].name | event.action | | items[].customerId | organization.id | | items[].ipAddress | source.ip, related.ip, source.as.*, source.geo.* | | items[].actor.email | source.user.email, source.user.name, source.user.domain | | items[].actor.profileId | source.user.id |

These are the common ones to all filesets.

Fields [_fields]

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