Skip to content

Latest commit

 

History

History
82 lines (64 loc) · 3.45 KB

File metadata and controls

82 lines (64 loc) · 3.45 KB

GSuite Exporter

This package handles exporting data from the GSuite Admin APIs to a destination.

The following GSuite Admin APIs are currently supported:

The following destinations are currently supported:

Requirements

  • A GSuite Admin account
  • A service account with:
  • On the service account's project:
    • Enable the Identity and Access Management (IAM) API.
  • On the destination project:
    • Enable the Admin Reports API.

Collectors

To collect data from the Admin SDK APIs, you need to grant extra permissions to your service account:

Exporters

Stackdriver Logging

To use the Stackdriver Logging exporter, you need to grant extra IAM roles to your service account:

  • roles/logging.viewer on the destination project
  • roles/logging.logWriter on the destination project

Installation

pip install gsuite-exporter

Usage

The GSuite Exporter can be used either using the command-line interface or as a Python library.

Using the CLI

An example sync from the Admin Reports API to Stackdriver Logging for the 'login' application looks like:

gsuite-exporter
  --credentials-path='/path/to/service/account/credentials.json'
  --admin-user='<your_gsuite_admin>@<your_domain>'
  --api='report_v1'
  --applications='login drive token'
  --project-id='<logging_project>'
  --exporter='stackdriver_exporter.StackdriverExporter'

The credentials_path variable is optional and you can use Application Default Credentials instead.

Using as a library

An example sync from the Admin Reports API to Stackdriver Logging looks like:

from gsuite_exporter.cli import sync_all

sync_all(
    credentials_path=/path/to/service/account/credentials.json,
    admin_user='<user>@<domain>',
    api='reports_v1',
    applications=['login', 'drive', 'token'],
    project_id='<project-id>',
    exporter_class='stackdriver_exporter.StackdriverExporter'
)

More examples are available using the library functions under the examples/ directory.