GSuite Exporter

此包处理将数据从 GSuite Admin APIs 导出到目的地。

目前支持以下 GSuite Admin APIs：

• reports_v1 - 报告API
  • admin - 管理活动报告
  • drive - Google Drive 活动报告
  • login - 登录活动报告
  • mobile - 移动活动报告
  • token - 授权令牌活动报告

目前支持以下目的地：

• Stackdriver Logging

需求

• 一个 GSuite Admin 账户
• 一个具有以下功能的服务账户
  • GSuite 域名范围委派已启用。
  • 授予项目中的服务账户 IAM 角色代码为 roles/iam.tokenCreator。
• 在服务账户的项目上
  • 启用 身份和访问管理（IAM）API。
• 在目的地项目上
  • 启用 管理报告API。

收集器

要从 Admin SDK APIs 收集数据，您需要授予您的服务账户额外的权限

• 转到您的 管理控制台，并使用您的 GSuite 管理员账户登录
• 导航到 安全 > 高级设置 > 管理API客户端访问
• 将以下作用域（以逗号分隔）授予您的服务账户的 client_id
  • https://www.googleapis.com/auth/admin.reports.audit.readonly
  • https://www.googleapis.com/auth/iam

导出工具

Stackdriver Logging

要使用 Stackdriver Logging 导出工具，您需要为您的服务账户授予额外的 IAM 角色

• 在目标项目上 roles/logging.viewer
• 在目标项目上 roles/logging.logWriter

安装

pip install gsuite-exporter

用法

GSuite 导出器 可以通过命令行界面或作为 Python 库来使用。

使用 CLI

以下是一个从管理员报告 API 同步到 Stackdriver Logging 的 'login' 应用程序的示例

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'

credentials_path 变量是可选的，您可以使用 应用程序默认凭据 代替。

作为库使用

以下是从管理员报告 API 同步到 Stackdriver Logging 的示例

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'
)

在 examples/ 目录下提供了更多使用库函数的示例。