此页面由 Cloud Translation API 翻译。

将 Google Workspace 与 Google SecOps 集成

本文档介绍了如何将 Google Workspace 与 Google Security Operations (Google SecOps) 集成。

集成版本：19.0

使用场景

将 Google Workspace 与 Google SecOps 集成有助于您解决以下使用情形：

用户离职流程和账号安全性：使用 Google SecOps 功能触发工作流，以撤消 Google Workspace 访问权限、暂停账号，并将离职用户的电子邮件转发给其他员工。

准备工作

在 Google SecOps 中配置 Google Workspace 集成之前，请完成以下前提步骤：

创建服务账号。
创建 JSON 密钥。
为集成创建自定义角色。
将自定义角色分配给用户。
向您的服务账号进行全网域授权。
为您的项目启用 Admin SDK API。

创建服务账号

如需创建服务账号，请完成以下步骤：

在 Google Cloud 控制台中，前往凭证页面。

转到“凭据”页面
从创建凭据菜单中选择服务账号。
在服务账号详情下，在服务账号名称字段中输入一个名称。
可选：修改服务账号 ID。
点击创建并继续。系统随即会显示权限界面。
点击继续。系统会显示具有访问权限的主账号界面。
点击完成。

向服务账号授予 Google Cloud IAM 角色

为确保服务账号在您的 Google Cloud项目中拥有所有必需的权限，请分配以下 IAM 角色：

在 Google Cloud 控制台中，前往 IAM 和管理 > IAM。
点击授予访问权限。
在新主账号字段中，输入您创建的服务账号的电子邮件地址。
在选择角色列表中，搜索并选择 Service Account Token Creator (roles/iam.serviceAccountTokenCreator) 角色。
点击保存。

创建 JSON 密钥

如需创建 JSON 密钥，请完成以下步骤：

选择您的服务账号，然后前往密钥。
点击添加密钥。
选择创建新密钥。
对于密钥类型，选择 JSON，然后点击创建。此时会显示一个对话框，提示私钥已保存到您的计算机，然后系统会将该私钥的副本下载到您的计算机。

为集成创建自定义角色

在 Google 管理控制台中，依次点击账号 > 管理员角色。
点击创建新角色。
为新的自定义角色提供名称，然后点击继续。
在选择权限页面上，前往 Admin API 权限部分。
在 Admin API 权限下，选择以下权限：
- 组织部门
- 用户
- 群组
点击继续。
如需创建新的自定义角色，请点击创建角色。

将自定义角色分配给用户

如需创建新用户，请前往目录 > 用户页面。
添加与服务账号关联的新用户。
打开新创建的用户的设置。系统会打开用户账号标签页。
点击管理员角色和权限。
依次点击修改修改。
选择您创建的自定义角色。
对于所选角色，将切换开关切换为已分配。

向您的服务账号进行全网域授权

在网域的 Google 管理控制台中，依次前往 主菜单 > 安全性 > 访问权限和数据控件 > API 控件。
在全网域授权窗格中，选择管理全网域授权。
点击新增。
在客户端 ID 字段中，输入在前述服务账号创建步骤中获得的客户端 ID。

在 OAuth 范围字段中，输入以下以英文逗号分隔的列表，其中包含您的应用所需的范围：

https://mail.google.com/,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/admin.directory.user,
https://www.googleapis.com/auth/admin.directory.group.member,
https://www.googleapis.com/auth/admin.directory.customer.readonly,
https://www.googleapis.com/auth/admin.directory.domain.readonly,
https://www.googleapis.com/auth/admin.directory.group,
https://www.googleapis.com/auth/admin.directory.orgunit,
https://www.googleapis.com/auth/admin.directory.user.alias,
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly,
https://www.googleapis.com/auth/apps.groups.settings,
https://www.googleapis.com/auth/admin.directory.user.security,
https://www.googleapis.com/auth/admin.reports.audit.readonly,
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly,
https://www.googleapis.com/auth/chrome.management.policy,
https://www.googleapis.com/auth/chrome.management.appdetails.readonly

点击授权。

为您的项目启用 Admin SDK API

在 Google Cloud 控制台中，前往 API 和服务。

进入“API 和服务”
点击启用 API 和服务。
为您的项目启用 Admin SDK API。

集成参数

Google Workspace 集成需要以下参数：

参数	说明
`Verify SSL`	可选。如果选中此复选框，集成会在连接到 Google Workspace 时验证 SSL 证书。此选项将会默认选中。
`User's Service Account JSON`	可选。服务账号密钥 JSON 文件的内容。您可以配置此参数或 `Workload Identity Email` 参数。如需配置此参数，请提供您在创建服务账号时下载的服务账号密钥 JSON 文件的完整内容。
`Delegated Email`	必填。集成要使用的电子邮件地址。
`Workload Identity Email`	可选。您的服务账号的客户端电子邮件地址。您可以配置此参数或 `User's Service Account JSON` 参数。如需使用工作负载身份联合模拟服务账号，请向您的服务账号授予 `Service Account Token Creator` 角色。如需详细了解工作负载身份以及如何使用它们，请参阅工作负载的身份。

如需了解如何在 Google SecOps 中配置集成，请参阅配置集成。

如有需要，您可以在稍后阶段进行更改。配置集成实例后，您可以在剧本中使用该实例。如需详细了解如何配置和支持多个实例，请参阅支持多个实例。

操作

如需详细了解操作，请参阅处理“工作台”中的待处理操作和执行手动操作。

向群组添加成员

使用 Add Members To Group 操作可将用户添加到群组。

此操作在 User 实体上运行。

将成员添加到群组操作可解决以下用例：

自动入职和离职。
通过授予临时访问权限来响应突发事件。
动态项目协作。

操作输入

向群组添加成员操作需要以下参数：

参数说明

参数	说明
`Group Email Address`	必填。要向其中添加新成员的群组的电子邮件地址。
`User Email Addresses`	可选。要添加到群组的用户的列表（以英文逗号分隔）。该操作会执行您为此参数配置的值以及 `User` 实体。

Group Email Address

必填。

要向其中添加新成员的群组的电子邮件地址。

User Email Addresses

可选。

要添加到群组的用户的列表（以英文逗号分隔）。

该操作会执行您为此参数配置的值以及 User 实体。

操作输出

向群组添加成员操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用向群组添加成员操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

屏蔽扩展程序

使用 Block Extension 操作可屏蔽组织部门中的指定 Chrome 扩展程序。

此操作不适用于 Google SecOps 实体。

操作输入

屏蔽扩展服务操作需要以下参数：

参数说明

参数	说明
`Organization Unit Name`	必填。要屏蔽相应扩展程序的组织部门的名称。
`Extension ID`	必填。要屏蔽的扩展程序的 ID。

Organization Unit Name

必填。

要屏蔽相应扩展程序的组织部门的名称。

Extension ID

必填。

要屏蔽的扩展程序的 ID。

操作输出

屏蔽扩展程序操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用屏蔽扩展程序操作时收到的 JSON 结果输出：

[
        {
            "targetKey": {
                "targetResource": "orgunits/example-org-unit-id",
                "additionalTargetKeys": {
                    "app_id": "chrome:exampleextensionid"
                }
            },
            "value": {
                "policySchema": "chrome.users.apps.InstallType",
                "value": {
                    "appInstallType": "BLOCKED"
                }
            },
            "sourceKey": {
                "targetResource": "orgunits/example-org-unit-id"
            },
            "addedSourceKey": {
                "targetResource": "orgunits/example-org-unit-id"
            }
        }
]

输出消息

屏蔽扩展服务操作可以返回以下输出消息：

输出消息消息说明

输出消息	消息说明
`Successfully blocked extension EXTENSION_ID in Organization Unit ORGANIZATION_NAME using Google Workspace.`	操作成功。
`Error executing action "Block Extension". Reason: ERROR_REASON`	操作失败。检查与服务器的连接、输入参数或凭据。

Successfully blocked extension EXTENSION_ID in Organization Unit ORGANIZATION_NAME using Google Workspace.

操作成功。

Error executing action "Block Extension". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用屏蔽扩展程序操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

创建群组

作为 Google Workspace 群组管理员，您可以使用创建群组操作在 Google 管理控制台、Groups API 或 Google Cloud Directory Sync 中为组织创建群组。

如果您使用群组企业版，还可以在 Google 群组中为贵组织创建群组。

此操作会在所有 Google SecOps 实体上运行。

您可以在以下使用情形中使用创建群组操作：

创建突发事件响应团队。
遏制网络钓鱼活动。
培训新用户和用户群组。
协作处理项目。
为敏感数据配置访问权限控制。

操作输入

创建群组操作需要以下参数：

参数说明

参数	说明
`Email Address`	必填。新群组的电子邮件地址。
`Name`	可选。新群组的名称。
`Description`	可选。新群组的说明。

Email Address

必填。

新群组的电子邮件地址。

Name

可选。

新群组的名称。

Description

可选。

新群组的说明。

操作输出

创建群组操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
脚本结果	可用

JSON 结果

以下示例介绍了使用 Create Group 操作时收到的 JSON 结果输出：

[
   {
      "kind":"admin#directory#group",
      "id":"ID",
      "etag":"TAG/var>",
      "email":"user@example.com",
      "name":"example",
      "description":"",
      "adminCreated":"True"
   }
]

脚本结果

下表介绍了使用 Create Group 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

创建组织部门

使用创建组织部门操作创建新的组织部门 (OU)。

此操作会在所有 Google SecOps 实体上运行。

您可以使用创建 OU 操作来解决以下使用情形：

为新部门提供初始配置。
隔离被盗用的账号。
针对数据驻留实施基于地理位置的政策。

操作输入

创建组织部门操作需要以下参数：

参数	说明
`Customer ID`	必填。客户的 Google Workspace 账号的唯一 ID。如需配置账号 `customerId`，您还可以使用以下占位符：`my_customer`。
`Name`	可选。新 OU 的名称。
`Description`	可选。新 OU 的说明。
`Parent OU Path`	必填。新组织部门的父组织部门的完整路径。

操作输出

创建组织部门操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
脚本结果	可用

JSON 结果

以下示例介绍了使用创建组织部门操作时收到的 JSON 结果输出：

[
   {
      "kind":"admin#directory#orgUnit",
      "etag":"TAG",
      "name":"example",
      "orgUnitPath":"/example_folder",
      "orgUnitId":"id:ID",
      "parentOrgUnitPath":"/",
      "parentOrgUnitId":"id:ID"
   }
]

脚本结果

下表介绍了使用 Create OU 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

创建用户

使用创建用户操作创建新用户。

当您将用户添加到您的 Google Workspace 账号后，他们将获得一个在您的企业网域中注册的电子邮件地址以及一个可用于访问 Google Workspace 服务的账号。

此操作会在所有 Google SecOps 实体上运行。

您可以使用创建用户操作来解决以下使用情形：

为新用户自动完成新手入门流程。
为合同员工提供临时访问权限。
使用沙盒进行突发事件响应。

操作输入

创建用户操作需要以下参数：

参数	说明
`Given Name`	必填。用户的名字。
`Family Name`	必填。用户的姓氏。
`Password`	必填。新用户的密码。
`Email Address`	必填。用户的主电子邮件地址。
`Phone`	可选。用户的手机号码。
`Gender`	可选。用户的性别。有效值如下：`female`、`male`、`other`、`unknown`。
`Department`	可选。用户所在部门的名称。
`Organization`	可选。用户所在组织的名称。
`Change Password At Next Login`	可选。如果选中此选项，系统会要求用户在下次尝试登录时更改密码。默认情况下未选中。

操作输出

创建用户操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
脚本结果	可用

JSON 结果

以下示例介绍了使用创建用户操作时收到的 JSON 结果输出：

[
   {
      "kind":"admin#directory#user",
      "id":"ID",
      "etag":"TAG",
      "primaryEmail":"example@example.com",
      "name":{
         "givenName":"FIRST_NAME",
         "familyName":"LAST_NAME"
      },
      "isAdmin":"False",
      "isDelegatedAdmin":"False",
      "creationTime":"2020-12-22T13:44:29.000Z",
      "organizations":[
         {
            "name":"ExampleOrganization"
         }
      ],
      "phones":[
         {
            "value":"(800)&nbsp;555&#8209;0175"
         }
      ],
      "gender":{
         "type":"male"
      },
      "customerId":"ID",
      "orgUnitPath":"/",
      "isMailboxSetup":"False"
   }
]

脚本结果

下表介绍了使用创建用户操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

删除扩展程序

预览版。使用 Delete Extension 操作从组织部门屏蔽名单中删除指定的 Chrome 扩展程序。

此操作不适用于 Google SecOps 实体。

操作输入

删除扩展服务操作需要以下参数：

参数说明

参数	说明
`Organization Unit Name`	必填。要从中删除扩展服务的组织部门的名称。
`Extension ID`	必填。要删除的扩展程序的 ID。

Organization Unit Name

必填。

要从中删除扩展服务的组织部门的名称。

Extension ID

必填。

要删除的扩展程序的 ID。

操作输出

删除扩展程序操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用删除扩展服务操作时收到的 JSON 结果输出：

[
  {
    "deleted_extensions": ["chrome:exampleextensionid"]
  }
]

输出消息

删除扩展程序操作可以返回以下输出消息：

输出消息消息说明

输出消息	消息说明
`Successfully deleted extension EXTENSION_ID from Organization Unit ORGANIZATION_NAME using Google Workspace.`	操作成功。
`Error executing action "Delete Extension". Reason: ERROR_REASON`	操作失败。检查与服务器的连接、输入参数或凭据。

Successfully deleted extension EXTENSION_ID from Organization Unit ORGANIZATION_NAME using Google Workspace.

操作成功。

Error executing action "Delete Extension". Reason:
ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用 Delete Extension 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

删除群组

使用 Delete Group 操作可删除 Google Workspace 目录群组。

此操作不适用于 Google SecOps 实体。

您可以使用删除群组操作来解决以下使用情形：

自动完成用户离职流程。
修复安全事件。
针对过时的群组执行清理操作。

操作输入

删除群组操作需要以下参数：

参数说明

参数	说明
`Group Email Address`	必填。要删除的群组的电子邮件地址。

Group Email Address

必填。

要删除的群组的电子邮件地址。

操作输出

删除群组操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
输出消息	可用
脚本结果	可用

输出消息

删除群组操作会提供以下输出消息：

输出消息消息说明

输出消息	消息说明
`Google Workspace group GROUP_EMAIL deleted.` `Action was not able to find Google Workspace group for deletion.`	操作成功。
`Failed to connect to the Google Workspace! Error is ERROR_DESCRIPTION`	操作失败。检查与服务器的连接、输入参数或凭据。

Google Workspace group GROUP_EMAIL deleted.

Action was not able to find Google Workspace group for deletion.

操作成功。

Failed to connect to the Google Workspace! Error is
      ERROR_DESCRIPTION

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用删除群组操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

删除组织部门

使用删除组织部门操作可删除组织部门。

如果组织中有用户、设备或下级组织，您将无法删除该组织。在删除组织之前，请先将其中的用户和设备移至其他组织，并移除所有下级组织。

此操作会在所有 Google SecOps 实体上运行。

您可以使用删除 OU 操作来解决以下使用情形：

自动完成用户离职流程。
修复安全事件。
管理项目资源并执行项目清理。

操作输入

删除组织部门操作需要以下参数：

参数说明

Customer ID

必填。

客户的 Google Workspace 账号的唯一 ID。

如需配置账号 customerId，您还可以使用以下占位符：my_customer。

OU Path

必填。

组织部门的完整路径。

如果组织部门位于根 (/) 路径下，请提供不带路径的组织部门名称。

操作输出

删除 OU 操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用 Delete OU 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

删除用户

使用删除用户操作删除用户账号。

删除用户后，该用户将无法访问或使用贵组织的任何 Google Workspace 服务。

您可以使用删除用户操作来解决以下使用情形：

为离职员工办理离职手续。
补救被盗用的账号。
自动清理临时账号。

此操作会在所有 Google SecOps 实体上运行。

操作输入

删除用户操作需要以下参数：

参数说明

参数	说明
`Email Address`	必填。要删除的用户的电子邮件地址。

Email Address

必填。

要删除的用户的电子邮件地址。

操作输出

删除用户操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用删除用户操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

丰富实体

使用丰富实体操作，利用 Google Workspace 中的信息丰富 Google SecOps 实体。

此操作在 User 实体上运行。

您可以使用丰富实体操作来解决以下使用情形：

调查用户。
分析钓鱼式电子邮件。
调查数据渗漏尝试。
检测恶意软件。

操作输入

无。

操作输出

丰富实体操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
实体丰富化表	可用
JSON 结果	可用
脚本结果	可用

实体丰富化

丰富实体操作支持以下实体丰富功能：

扩充项字段名称	丰富化逻辑
`Phones`	如果存在于 JSON 结果中，则返回。
`isDelegatedAdmin`	如果存在于 JSON 结果中，则返回。
`suspended`	如果存在于 JSON 结果中，则返回。
`id`	如果存在于 JSON 结果中，则返回。
`nonEditableAliases`	如果存在于 JSON 结果中，则返回。
`archived`	如果存在于 JSON 结果中，则返回。
`isEnrolledIn2Sv`	如果存在于 JSON 结果中，则返回。
`includeInGlobalAddressList`	如果存在于 JSON 结果中，则返回。
`Relations`	如果存在于 JSON 结果中，则返回。
`isAdmin`	如果存在于 JSON 结果中，则返回。
`etag`	如果存在于 JSON 结果中，则返回。
`lastLoginTime`	如果存在于 JSON 结果中，则返回。
`orgUnitPath`	如果存在于 JSON 结果中，则返回。
`agreedToTerms`	如果存在于 JSON 结果中，则返回。
`externalIds`	如果存在于 JSON 结果中，则返回。
`ipWhitelisted`	如果存在于 JSON 结果中，则返回。
`kind`	如果存在于 JSON 结果中，则返回。
`isEnforcedIn2Sv`	如果存在于 JSON 结果中，则返回。
`isMailboxSetup`	如果存在于 JSON 结果中，则返回。
`emails`	如果存在于 JSON 结果中，则返回。
`organizations`	如果存在于 JSON 结果中，则返回。
`primaryEmail`	如果存在于 JSON 结果中，则返回。
`name`	如果存在于 JSON 结果中，则返回。
`gender`	如果存在于 JSON 结果中，则返回。
`creationTime`	如果存在于 JSON 结果中，则返回。
`changePasswordAtNextLogin`	如果存在于 JSON 结果中，则返回。
`customerId`	如果存在于 JSON 结果中，则返回。

JSON 结果

以下示例介绍了使用丰富实体操作时收到的 JSON 结果输出：

[{
    "Phones":
       [{
          "customType": "",
          "type": "custom",
          "value": "(800)&nbsp;555&#8209;0175"
       }],
   "isDelegatedAdmin": false,
   "suspended": false,
   "id": "ID",
   "nonEditableAliases": ["user@example.com"],
   "archived": false,
   "isEnrolledIn2Sv": true,
   "includeInGlobalAddressList": true,
   "Relations":
        [{
          "type": "manager",
          "value": "user@example.com"
        }],
   "isAdmin": false,
   "etag": "E_TAG_VALUE",
   "lastLoginTime": "2019-02-11T12:24:41.000Z",
   "orgUnitPath": "/OU-1",
   "agreedToTerms": true,
   "externalIds": [{"type": "organization",
                    "value": ""}],
   "ipWhitelisted": false,
   "kind": "admin#directory#user",
   "isEnforcedIn2Sv": true,
   "isMailboxSetup": true,
   "emails":
       [{
          "primary": true,
          "address": "user@example.com"
        },
        {
          "address": "user@example.com"
        }],
    "organizations":
        [{
           "department": "R&D",
           "customType": "", "name": "Company"
         }],
     "primaryEmail": "user@example.com",
     "name":
         {
            "fullName": "NAME SURNAME",
            "givenName": "NAME",
            "familyName": "SURNAME"
         },
     "gender": {"type": "male"},
     "creationTime": "2017-10-26T06:57:13.000Z",
     "changePasswordAtNextLogin": false,
     "customerId": "CUSTOMER_ID"
}]

脚本结果

下表介绍了使用 Enrich Entities 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

获取扩展程序详细信息

使用 Get Extension Details 操作可检索有关指定 Chrome 扩展程序的信息。

此操作不适用于 Google SecOps 实体。

操作输入

“获取扩展程序详细信息”操作需要以下参数：

参数说明

参数	说明
`Extension ID`	必填。要扩充的扩展程序 ID 的逗号分隔列表。
`Max Requesting Users To Return`	必填。要返回的请求安装扩展程序的用户数量上限。最大值为 `1000`。
`Max Requesting Devices To Return`	必填。要返回的请求安装扩展程序的设备数量上限。最大值为 `1000`。

Extension ID

必填。

要扩充的扩展程序 ID 的逗号分隔列表。

Max Requesting Users To Return

必填。

要返回的请求安装扩展程序的用户数量上限。

最大值为 1000。

Max Requesting Devices To Return

必填。

要返回的请求安装扩展程序的设备数量上限。

最大值为 1000。

操作输出

获取扩展程序详细信息操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用获取扩展程序详情操作时收到的 JSON 结果输出：

[
  {
    "Entity": "Example Extension Name",
    "EntityResult": {
      "name": "customers/example-customer-id/apps/chrome/exampleextensionid",
      "displayName": "Example Extension Name",
      "description": "A description for an example extension.",
      "appId": "exampleextensionid",
      "revisionId": "11.3.0.0",
      "type": "CHROME",
      "iconUri": "https://lh3.googleusercontent.com/KxYKwMcAzhn_DBMVIb0mtvIOsAME2d8-csv5d_vnKYX6PL3D6BGbVy3hH68ky8nM9yTDGAPl6B77pA7tpu4_jeUkXw",
      "detailUri": "https://chromewebstore.google.com/detail/exampleextensionid",
      "firstPublishTime": "2011-12-14T06:57:01.918Z",
      "latestPublishTime": "2025-07-01T02:05:04.252Z",
      "publisher": "example-publisher",
      "reviewNumber": "5423",
      "reviewRating": 4,
      "chromeAppInfo": {
        "supportEnabled": true,
        "minUserCount": 3000000,
        "permissions": [
          {
            "type": "offscreen"
          },
          {
            "type": "scripting",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/scripting/",
            "accessUserData": false
          },
          {
            "type": "storage",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/storage/",
            "accessUserData": false
          },
          {
            "type": "tabs",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/tabs#type-Tab",
            "accessUserData": true
          }
        ],
        "siteAccess": [
          {
            "hostMatch": "https://*/*"
          },
          {
            "hostMatch": "http://*/*"
          }
        ],
        "isTheme": false,
        "googleOwned": true,
        "isCwsHosted": true,
        "kioskEnabled": false,
        "isKioskOnly": false,
        "type": "EXTENSION",
        "isExtensionPolicySupported": false,
        "manifestVersion": "3",
        "requestingUserDetails": [
          {
            "email": "user@example.com",
            "justification": "Example justification for the request."
          }
        ],
        "requestingDeviceDetails": [
          {
            "device": "example-device-id",
            "justification": "Example justification for the request."
          }
        ]
      }
    }
  }
]

输出消息

获取扩展程序详细信息操作可以返回以下输出消息：

输出消息消息说明

输出消息	消息说明
`Successfully returned information about the following extensions in Google Workspace: EXTENSION_IDS.` `Action wasn't able to return information about the following extension in Google Workspace: EXTENSION_IDS.` `No information about the provided extensions were found.`	操作成功。
`Error executing action "Get Extension Details". Reason: ERROR_REASON`	操作失败。检查与服务器的连接、输入参数或凭据。

Successfully returned information about the following extensions in Google Workspace: EXTENSION_IDS.

Action wasn't able to return information about the following extension in Google Workspace: EXTENSION_IDS.

No information about the provided extensions were found.

操作成功。

Error executing action "Get Extension Details". Reason:
  ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用获取扩展程序详细信息操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

获取群组详细信息

使用 Get Group Details 操作可检索有关 Google Workspace 中群组的信息。

此操作不适用于 Google SecOps 实体。

操作输入

获取群组详细信息操作需要以下参数：

参数说明

参数	说明
`Group Email Addresses`	必填。要检查的群组电子邮件地址的英文逗号分隔列表。

Group Email Addresses

必填。

要检查的群组电子邮件地址的英文逗号分隔列表。

操作输出

获取群组详情操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例描述了使用获取群组详情操作时收到的 JSON 结果输出：

{
        "Entity": "group@example.com",
        "EntityResult": {
            "kind": "groupsSettings#groups",
            "email": "group@example.com",
            "name": "GROUP_NAME",
            "description": "DESCRIPTION",
            "whoCanJoin": "CAN_REQUEST_TO_JOIN",
            "whoCanViewMembership": "ALL_MEMBERS_CAN_VIEW",
            "whoCanViewGroup": "ALL_MEMBERS_CAN_VIEW",
            "whoCanInvite": "ALL_MANAGERS_CAN_INVITE",
            "whoCanAdd": "ALL_MANAGERS_CAN_ADD",
            "allowExternalMembers": "false",
            "whoCanPostMessage": "ANYONE_CAN_POST",
            "allowWebPosting": "true",
            "primaryLanguage": "en_US",
            "maxMessageBytes": 26214400,
            "isArchived": "false",
            "archiveOnly": "false",
            "messageModerationLevel": "MODERATE_NONE",
            "spamModerationLevel": "MODERATE",
            "replyTo": "REPLY_TO_IGNORE",
            "includeCustomFooter": "false",
            "customFooterText": "",
            "sendMessageDenyNotification": "false",
            "defaultMessageDenyNotificationText": "",
            "showInGroupDirectory": "true",
            "allowGoogleCommunication": "false",
            "membersCanPostAsTheGroup": "false",
            "messageDisplayFont": "DEFAULT_FONT",
            "includeInGlobalAddressList": "true",
            "whoCanLeaveGroup": "ALL_MEMBERS_CAN_LEAVE",
            "whoCanContactOwner": "ANYONE_CAN_CONTACT",
            "whoCanAddReferences": "NONE",
            "whoCanAssignTopics": "NONE",
            "whoCanUnassignTopic": "NONE",
            "whoCanTakeTopics": "NONE",
            "whoCanMarkDuplicate": "NONE",
            "whoCanMarkNoResponseNeeded": "NONE",
            "whoCanMarkFavoriteReplyOnAnyTopic": "NONE",
            "whoCanMarkFavoriteReplyOnOwnTopic": "NONE",
            "whoCanUnmarkFavoriteReplyOnAnyTopic": "NONE",
            "whoCanEnterFreeFormTags": "NONE",
            "whoCanModifyTagsAndCategories": "NONE",
            "favoriteRepliesOnTop": "true",
            "whoCanApproveMembers": "ALL_MANAGERS_CAN_APPROVE",
            "whoCanBanUsers": "OWNERS_AND_MANAGERS",
            "whoCanModifyMembers": "OWNERS_AND_MANAGERS",
            "whoCanApproveMessages": "OWNERS_AND_MANAGERS",
            "whoCanDeleteAnyPost": "OWNERS_AND_MANAGERS",
            "whoCanDeleteTopics": "OWNERS_AND_MANAGERS",
            "whoCanLockTopics": "OWNERS_AND_MANAGERS",
            "whoCanMoveTopicsIn": "OWNERS_AND_MANAGERS",
            "whoCanMoveTopicsOut": "OWNERS_AND_MANAGERS",
            "whoCanPostAnnouncements": "OWNERS_AND_MANAGERS",
            "whoCanHideAbuse": "NONE",
            "whoCanMakeTopicsSticky": "NONE",
            "whoCanModerateMembers": "OWNERS_AND_MANAGERS",
            "whoCanModerateContent": "OWNERS_AND_MANAGERS",
            "whoCanAssistContent": "NONE",
            "customRolesEnabledForSettingsToBeMerged": "false",
            "enableCollaborativeInbox": "false",
            "whoCanDiscoverGroup": "ALL_IN_DOMAIN_CAN_DISCOVER",
            "defaultSender": "DEFAULT_SELF"
        }
    }

输出消息

获取群组详情操作提供以下输出消息：

输出消息消息说明

输出消息	消息说明
`Successfully enriched the following groups using information from Google Workspace: GROUPS` `Action wasn't able to enrich the following group using information from Google Workspace: GROUPS` `None of the groups were enriched.`	操作成功。
`Error executing action "Get Group Details". Reason: ERROR_REASON`	操作失败。检查与服务器的连接、输入参数或凭据。

Successfully enriched the following groups using information from Google Workspace: GROUPS

Action wasn't able to enrich the following group using information from Google Workspace: GROUPS

None of the groups were enriched.

操作成功。

Error executing action "Get Group Details". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用 Get Group Details 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

获取宿主浏览器详细信息

使用 Get Host Browser Details 操作可检索与指定 Google SecOps Hostname 实体关联的浏览器相关信息。

此操作在 Google SecOps Hostname 实体上运行。

操作输入

无。

操作输出

获取主机浏览器详细信息操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用获取主机浏览器详细信息操作时收到的 JSON 结果输出：

{
   "Entity": "example.host.com",
   "EntityResult": [
      {
         "deviceId": "example-device-id",
         "kind": "admin#directory#browserdevice",
         "lastPolicyFetchTime": "2025-07-25T12:11:17.546Z",
         "osPlatform": "Linux",
         "osArchitecture": "x86_64",
         "osVersion": "6.12.27-1rodete1-amd64",
         "machineName": "example.host.com",
         "lastRegistrationTime": "2025-07-07T07:45:20.504Z",
         "extensionCount": "15",
         "policyCount": "23",
         "lastDeviceUser": "example-user",
         "lastActivityTime": "2025-07-26T12:13:55.385Z",
         "osPlatformVersion": "Linux 6.12.27-1rodete1-amd64",
         "browserVersions": [
            "140.0.7259.2 (Dev)"
         ],
         "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
         "lastDeviceUsers": [
            {
               "userName": "example-user",
               "lastStatusReportTime": "2025-07-26T07:46:00.919Z"
            }
         ],
         "machinePolicies": [
            {
               "source": "MACHINE_LEVEL_USER_CLOUD",
               "name": "CloudReportingEnabled",
               "value": "true"
            }
         ],
         "browsers": [
            {
               "browserVersion": "140.0.7259.2",
               "channel": "DEV",
               "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
               "executablePath": "/opt/google/chrome-unstable",
               "profiles": [
                  {
                     "name": "Example User Profile",
                     "id": "/home/example_user/.config/google-chrome/Default",
                     "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
                     "lastPolicyFetchTime": "2025-07-25T12:11:17.546Z",
                     "chromeSignedInUserEmail": "user@example.com",
                     "extensions": [
                        {
                           "extensionId": "exampleextensionid",
                           "version": "2.0.6",
                           "permissions": [
                              "alarms",
                              "contextMenus",
                              "management",
                              "storage",
                              "https://accounts.google.com/*",
                              "https://appengine.google.com/*",
                              "https://example.com/*",
                              "https://example.org/*",
                              "https://example-api.com/*",
                              "https://docs.example.com/*",
                              "https://internal.example.net/*",
                              "https://partners.example.com/*",
                              "https://www.google.com/*"
                           ],
                           ],
                           "name": "Example Extension",
                           "description": "This is a description for an example extension.",
                           "appType": "EXTENSION",
                           "homepageUrl": "https://chromewebstore.google.com/detail/exampleextensionid",
                           "installType": "ADMIN",
                           "manifestVersion": 3
                        }
                     ],
                     "userPolicies": [
                        {
                           "source": "USER_CLOUD",
                           "name": "CloudProfileReportingEnabled",
                           "value": "true"
                        }
                     ]
                  }
               ],
               "pendingInstallVersion": "140.0.7312.0"
            }
         ],
         "virtualDeviceId": "example-virtual-device-id",
         "orgUnitPath": "/",
         "deviceIdentifiersHistory": {
            "records": [
               {
                  "identifiers": {
                     "machineName": "example.host.com"
                  },
                  "firstRecordTime": "2025-06-03T08:06:33.895Z",
                  "lastActivityTime": "2025-07-26T07:46:01.325Z"
               }
            ]
         }
      }
   ]
}

输出消息

获取主机浏览器详细信息操作可以返回以下输出消息：

输出消息消息说明

输出消息	消息说明
`Successfully returned browsers related to the following hostnames in Google Workspace: HOSTNAME.` `No browsers were associated with the following hostnames in Google Workspace: HOSTNAME.` `No browsers were associated with provided hostnames.`	操作成功。
`Error executing action "Get Host Browser Details". Reason: ERROR_REASON`	操作失败。检查与服务器的连接、输入参数或凭据。

Successfully returned browsers related to the following hostnames in Google Workspace: HOSTNAME.

No browsers were associated with the following hostnames in Google Workspace: HOSTNAME.

No browsers were associated with provided hostnames.

操作成功。

Error executing action "Get Host Browser Details". Reason:
ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用获取宿主浏览器详细信息操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

列出群组成员

使用列出群组成员操作列出 Google Workspace 群组的成员。

此操作会在所有 Google SecOps 实体上运行。

您可以使用 List Group Members 操作来解决以下使用情形：

自动执行用户入职和离职流程。
执行安全审核。
应对相关事件。
支持动态资源访问。

操作输入

列出群组成员操作需要以下参数：

参数说明

参数	说明
`Group Email Address`	必填。群组的电子邮件地址。
`Include Derived Membership`	可选。如果选中，则列出群组中用户的间接成员资格。此选项将会默认选中。

Group Email Address

必填。

群组的电子邮件地址。

Include Derived Membership

可选。

如果选中，则列出群组中用户的间接成员资格。

此选项将会默认选中。

操作输出

列出群组成员操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
脚本结果	可用

JSON 结果

以下示例描述了使用列出群组成员操作时收到的 JSON 结果输出：

{
   "status": "ACTIVE",
   "kind": "admin#directory#member",
   "email": "user1@example.com",
   "etag": "E_TAG_VALUE",
   "role": "MEMBER",
   "type": "USER",
   "id": "ID"
  },{
   "status": "ACTIVE",
   "kind": "admin#directory#member",
   "email": "user2@example.com",
   "etag": "E_TAG_VALUE",
   "role": "MEMBER",
   "type": "USER", "id": "ID"
}

脚本结果

下表介绍了使用列出群组成员操作时脚本结果输出的值：

脚本结果名称	值
`members`	`True` 或 `False`

列出群组权限

使用列出群组权限操作可列出与 Google Workspace 群组相关的角色和权限。

此操作不适用于 Google SecOps 实体。

操作输入

列出群组权限操作需要以下参数：

参数	说明
`Group Email Addresses`	可选。要检查的群组的英文逗号分隔列表。
`Check Roles`	可选。要检查的与群组相关的角色列表（以英文逗号分隔）。
`Check Privileges`	可选。要检查的与群组相关的权限的英文逗号分隔列表。此参数要求您选择扩大权限参数。如果您配置了 Check Roles 参数，该操作将仅检查您列出的角色的权限。
`Expand Privileges`	可选。如果选择此值，操作会返回与该群组相关的所有唯一权限的信息。
`Max Roles To Return`	必填。要返回的与群组相关的角色数量上限。默认值为 `100`。
`Max Privileges To Return`	必填。要返回的与群组相关的权限数量上限。默认值为 `100`。

操作输出

列出群组权限操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例介绍了使用 List Group Privileges 操作时收到的 JSON 结果输出：

{
    "Entity": "user@example.com",
    "EntityResult": {
        "roles": [
            "Role1",
            "_GROUPS_EDITOR_ROLE",
            "example-role"
        ],
        "unique_privileges": [
            "VIEW_SITE_DETAILS",
            "ACCESS_EMAIL_LOG_SEARCH",
            "ACCESS_ADMIN_QUARANTINE",
            "ACCESS_RESTRICTED_QUARANTINE",
            "ADMIN_QUALITY_DASHBOARD_ACCESS",
            "MANAGE_DLP_RULE",
            "DASHBOARD_ACCESS",
            "MANAGE_GSC_RULE",
            "VIEW_GSC_RULE",
            "SECURITY_HEALTH_DASHBOARD_ACCESS",
            "SIT_CALENDAR_VIEW_METADATA",
            "SIT_CHAT_VIEW_METADATA",
            "SIT_CHROME_VIEW_METADATA",
            "SIT_DEVICE_UPDATE_DELETE",
            "SIT_DEVICE_VIEW_METADATA",
            "SIT_DRIVE_UPDATE_DELETE"
        ]
    }
}

输出消息

列出群组权限操作会提供以下输出消息：

输出消息消息说明

Successfully fetched information for the following groups using information from Google Workspace: GROUPS

Action wasn't able to fetch information for the following groups using information from Google Workspace: GROUPS

None of the specific roles/privileges were found for the following groups in Google Workspace: GROUPS

None of the specific roles/privileges were found for the provided groups in Google Workspace.

No information was found for the provided groups in Google Workspace.

操作成功。

Error executing action "List Group Privileges". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用 List Group Privileges 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

列出账号的组织部门

使用列出账号的组织机构部门操作列出账号的组织机构部门。

此操作会在所有 Google SecOps 实体上运行。

您可以使用列出账号的组织部门操作来解决以下使用情形：

自动执行用户离职流程。
执行有针对性的安全审核。
自动管理群组成员资格。
简化用户预配。
自动生成合规性报告和执行合规性审核。

集成输入

列出账号的组织单位操作需要以下参数：

参数说明

Customer ID

必填。

客户 Google Workspace 账号的唯一 ID。

如需表示账号的 customerId 值，请使用 my_customer 占位符。

Organization Unit Path

可选。

要返回的组织部门的路径。

默认值为 /。

Max Organization Units

必填。

要返回的组织单元数量上限。

最大值为 100。

默认值为 50。

操作输出

列出账号的组织部门操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
脚本结果	可用

JSON 结果

以下示例描述了使用列出账号的组织部门操作时收到的 JSON 结果输出：

[{
   "kind": "admin#directory#orgUnit",
   "parentOrgUnitPath": "/",
   "name": "OU-1",
   "etag": "E_TAG_VALUE",
   "orgUnitPath": "/OU-1",
   "parentOrgUnitId": "id:1455",
   "blockInheritance": false,
   "orgUnitId": "id:123",
   "description": ""
}]

脚本结果

下表介绍了使用 列出账号的组织部门操作时脚本结果输出的值：

脚本结果名称	值
`organizational_units`	`True` 或 `False`

列出用户权限

使用列出用户权限操作列出与 Google Workspace 中的用户相关的角色和权限。

此操作在 Google SecOps User 实体上运行。

操作输入

列出用户权限操作需要以下参数：

参数	说明
`User Email Addresses`	可选。要检查的用户的列表（以英文逗号分隔）。该操作会执行您为此参数配置的值以及 `User` 实体。
`Check Roles`	可选。要检查的与用户相关的角色列表（以英文逗号分隔）。
`Check Privileges`	可选。要验证的与用户相关的权限的列表（以英文逗号分隔）。此参数要求您选择扩大权限参数。如果您配置了 Check Roles 参数，该操作将仅检查您列出的角色的权限。
`Include Inherited Roles`	可选。如果选中，该操作还会返回从群组继承的用户角色。
`Expand Privileges`	可选。如果选择此值，则操作会返回与用户相关的所有唯一权限的信息。
`Max Roles To Return`	必填。要返回的与用户相关的角色数量上限。默认值为 `100`。
`Max Privileges To Return`	必填。要返回的与用户相关的权限数量上限。默认值为 `100`。

操作输出

列出用户权限操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例介绍了使用列出用户权限操作时收到的 JSON 结果输出：

{
    "Entity": "user@example.com",
    "EntityResult": {
        "roles": [
            "Role1",
            "_GROUPS_EDITOR_ROLE",
            "example-role"
        ],
        "unique_privileges": [
            "VIEW_SITE_DETAILS",
            "ACCESS_EMAIL_LOG_SEARCH",
            "ACCESS_ADMIN_QUARANTINE",
            "ACCESS_RESTRICTED_QUARANTINE",
            "ADMIN_QUALITY_DASHBOARD_ACCESS",
            "MANAGE_DLP_RULE",
            "DASHBOARD_ACCESS",
            "MANAGE_GSC_RULE",
            "VIEW_GSC_RULE",
            "SECURITY_HEALTH_DASHBOARD_ACCESS",
            "SIT_CALENDAR_VIEW_METADATA",
            "SIT_CHAT_VIEW_METADATA",
            "SIT_CHROME_VIEW_METADATA",
            "SIT_DEVICE_UPDATE_DELETE",
            "SIT_DEVICE_VIEW_METADATA",
            "SIT_DRIVE_UPDATE_DELETE"
        ]
    }
}

输出消息

列出用户权限操作提供以下输出消息：

输出消息消息说明

Successfully enriched the following users using information from Google Workspace: USERS

Action wasn't able to enrich the following users using information from Google Workspace: USERS

None of the specific roles/privileges were found for the following users in Google Workspace: USERS

None of the specific roles/privileges were found for the provided users in Google Workspace.

None of the provided users were enriched in Google Workspace.

操作成功。

Error executing action "List User Privileges". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用 List User Privileges 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

列出用户

使用 List Users 操作列出账号中的用户。

此操作不适用于 Google SecOps 实体。

您可以使用 List Users 操作来解决以下使用情形：

识别可能被盗用的账号。
实现离职流程自动化。
审核和管理用户访问权限
调查可疑活动。
管理用户许可和资源。

操作输入

列出用户操作需要以下参数：

参数	说明
`Customer ID`	可选。客户 Google Workspace 账号的唯一 ID。如果您未提供此参数值，该操作会自动使用 `my_customer` 占位符来表示相应账号的客户 ID。
`Domain`	可选。要搜索用户的网域。
`Manager Email`	可选。用户主管的电子邮件地址。
`Return Only Admin Accounts?`	可选。如果选择此值，则操作仅返回管理员账号。默认情况下未选中。
`Return Only Delegated Admin Accounts?`	可选。如果选择此值，操作将仅返回委托的管理员账号。默认情况下未选中。
`Return Only Suspended Users?`	可选。如果选择此值，则操作仅返回已暂停的账号。默认情况下未选中。
`Org Unit Path`	可选。要从中检索用户的组织部门的完整路径。相应路径与目标组织部门下列出的所有组织部门链匹配。
`Department`	可选。要从中检索用户的组织内的部门。
`Record Limit`	可选。要返回的操作的数据记录数上限。默认值为 `20`。
`Custom Query Parameter`	可选。要添加到列出用户搜索调用中的自定义查询参数，例如 `orgName='Human Resources'`。您可以使用 `email` 字段配置此参数，也可以将 `email` 字段留空并配置 `Email Addresses` 参数。如果您同时配置 `email` 字段和 `Email Addresses` 参数，则生成的查询会失败。
`Return only users without 2fa?`	可选。如果选择此项，该操作只会返回未启用双重身份验证 (2FA) 的用户。默认情况下未选中。
`Email Addresses`	可选。要搜索的电子邮件地址列表，以英文逗号分隔。如果您配置此参数，请勿在 `Custom Query Parameter` 参数中配置 `email` 字段。如果您配置此参数，操作会忽略 `Record Limit` 参数。

操作输出

列出用户 操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

“支持请求墙”表格

列出用户操作会在案例墙上显示下表：

表格名称：Google G Suite 用户

表列：

ID
电子邮件
Given Name
Family Name
Is Admin?
是否为委派的管理员？
创建时间
上次登录时间
是否已暂停？
已归档？
下次登录时更改密码？
客户 ID
组织部门路径
是否已设置邮箱？
辅助邮箱

JSON 结果

以下示例介绍了使用 List Users 操作时收到的 JSON 结果输出：

{
    "kind": "admin#directory#users",
    "etag": "E_TAG_VALUE",
    "users": [
        {
            "kind": "admin#directory#user",
            "id": "ID",
            "etag": "E_TAG_VALUE",
            "primaryEmail": "user@example.com",
            "name": {
                "givenName": "NAME",
                "familyName": "SURNAME",
                "fullName": "NAME SURNAME"
            },
            "isAdmin": true,
            "isDelegatedAdmin": false,
            "lastLoginTime": "2020-12-22T06:40:34.000Z",
            "creationTime": "2020-07-22T09:23:28.000Z",
            "agreedToTerms": true,
            "suspended": false,
            "archived": false,
            "changePasswordAtNextLogin": false,
            "ipWhitelisted": false,
            "emails": [
                {
                    "address": "user@example.com",
                    "primary": true
                },
                {
                    "address": "user@example.com"
                }
            ],
            "nonEditableAliases": [
                "user@example.com"
            ],
            "customerId": "CUSTOMER_ID",
            "orgUnitPath": "/Management",
            "isMailboxSetup": true,
            "isEnrolledIn2Sv": false,
            "isEnforcedIn2Sv": false,
            "includeInGlobalAddressList": true,
            "recoveryEmail": "email@example.com"
        }
    ]
}

输出消息

列出用户操作提供以下输出消息：

输出消息消息说明

Action successfully returned the Google Workspace Directory user list.

No users were returned.

操作成功。

Failed to connect to the Google Workspace! Error is
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用 List Users 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

Ping

使用 Ping 操作测试与 Google Workspace 的连接。

此操作会在所有 Google SecOps 实体上运行。

操作输入

无。

操作输出

Ping 操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用 Ping 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

从群组中移除成员

使用从群组中移除成员操作可从 Google Workspace 群组中移除成员。

此操作在 Google SecOps User 实体上运行。

您可以使用 List Users 操作来解决以下使用情形：

自动执行用户离职流程。
执行动态群组管理。
修复访问权限控制问题。

操作输入

从群组中移除成员操作需要以下参数：

参数说明

Group Email Address

必填。

要从中移除成员的群组的电子邮件地址。

User Email Addresses

可选。

要从群组中移除的用户的列表（以英文逗号分隔）。

该操作会执行您为此参数配置的值以及 User 实体。

操作输出

从群组中移除成员操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用从群组中移除成员操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

撤消用户会话

使用撤消用户会话操作撤消用户的 Google Workspace 网络会话和设备会话，并重置其登录 Cookie。

此操作在 Google SecOps User 实体上运行。

操作输入

撤消用户会话操作需要以下参数：

参数说明

User Email Addresses

可选。

要退出的用户的列表（以英文逗号分隔）。此操作会使用 Google SecOps User 实体运行此参数中的值。

操作输出

撤消用户会话操作会提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用撤消用户会话操作时收到的 JSON 结果输出：

[
   {
       "Entity": "ENTITY_ID",
       "EntityResult": {
           "Status": "done"
       }
   }
]

输出消息

撤消用户会话操作可能会返回以下输出消息：

输出消息消息说明

Successfully signed out the following users using Google Workspace: USERS

Action wasn't able to sign out the following users using Google Workspace: USERS

None of the provided users were found in Google Workspace.

操作成功。

Error executing action "Revoke User Sessions". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用撤消用户会话操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

搜索用户活动事件

使用 Search User Activity Events 操作从指定 Google SecOps User 实体的应用中检索活动事件。

此操作在 Google SecOps User 实体上运行。

操作输入

搜索用户活动事件操作需要以下参数：

参数	说明
`User Email Addresses`	可选。要处理的其他用户电子邮件地址的列表（以英文逗号分隔）。该操作会处理此列表中的所有用户，以及 `User` 实体（如果已提供）。
`Application Names`	必填。要查询活动事件的应用列表。如需查看支持的应用的完整列表，请参阅 ApplicationName 文档。
`Event Type Filter`	可选。要检索的事件类型的英文逗号分隔列表。
`Time Frame`	可选。活动搜索的时间范围。可能的值如下： `Last Hour` `Last 6 Hours` `Last 24 Hours` `Last Week` `Last Month` `Custom` 如果选择 `Custom`，则 `Start Time` 参数是必需的。默认值为 `Last Hour`。
`Start Time`	可选。活动搜索的时间范围的开始时间。如果为 `Time Frame` 参数选择了 `Custom`，则此参数是必需的。以 ISO 8601 格式配置值。
`End Time`	可选。活动搜索的时间范围的结束时间。如果为 `Time Frame` 参数选择 `Custom`，则此参数为可选参数；如果未提供，则默认为当前时间。以 ISO 8601 格式配置值。
`Max Events To Return`	必填。每位用户返回的事件数量上限。该操作最多可处理每位用户每个应用的 `1000` 个事件。默认值为 `200`。最大值为 `1000`。

操作输出

搜索用户活动事件操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	可用
输出消息	可用
脚本结果	可用

JSON 结果

以下示例展示了使用搜索用户活动事件操作时收到的 JSON 结果输出：

{
   "Entity": "user@example.com",
   "EntityResult": [
      {
         "applicationName": "login",
         "type": "login",
         "name": "login_success",
         "parameters": [
            {
               "name": "login_type",
               "value": "google_password"
            },
            {
               "name": "login_challenge_method",
               "multiValue": [
                  "password"
               ]
            },
            {
               "name": "is_suspicious",
               "boolValue": false
            }
         ]
      },
      {
         "applicationName": "token",
         "type": "auth",
         "name": "authorize",
         "parameters": [
            {
               "name": "client_id",
               "value": "example-client-id.apps.googleusercontent.com"
            },
            {
               "name": "app_name",
               "value": "Google Chrome"
            },
            {
               "name": "client_type",
               "value": "NATIVE_DESKTOP"
            },
            {
               "name": "scope_data",
               "multiMessageValue": [
                  {
                     "parameter": [
                        {
                           "name": "scope_name",
                           "value": "https://www.google.com/accounts/OAuthLogin"
                        },
                        {
                           "name": "product_bucket",
                           "multiValue": [
                              "IDENTITY"
                           ]
                        }
                     ]
                  }
               ]
            },
            {
               "name": "scope",
               "multiValue": [
                  "https://www.google.com/accounts/OAuthLogin"
               ]
            }
         ]
      }
   ]
}

输出消息

搜索用户活动事件操作可以返回以下输出消息：

输出消息消息说明

Successfully found events for the following users in Google Workspace: USERS.

No events were found for the following users in Google Workspace: USERS.

No events were found for the provided users in Google Workspace.

操作成功。

Error executing action "Search User Activity Events". Reason:
ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表列出了使用 Search User Activity Events 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

更新组织部门

使用更新组织部门操作来更新组织部门 (OU)。

此操作会在所有 Google SecOps 实体上运行。

您可以使用更新组织部门操作来解决以下使用情形：

管理安全组。
自动执行用户入职和离职流程。
实施数据分离政策。

操作输入

更新组织部门操作需要以下参数：

参数	说明
`Customer ID`	必填。客户 Google Workspace 账号的唯一 ID。如需表示账号的 `customerId` 值，请使用 `my_customer` 占位符。
`Name`	可选。组织部门的名称。
`Description`	可选。组织单元的说明。
`OU Path`	必填。组织单位的完整路径。如果组织部门位于根路径 `/` 下，则仅提供组织部门名称，而不提供路径。

操作输出

更新 OU 操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
脚本结果	可用

脚本结果

下表介绍了使用更新 OU 操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`

更新用户

使用 Update User 操作更新 Google Workspace 目录用户。

此操作不适用于 Google SecOps 实体。

您可以使用 Update User 操作来解决以下使用情形：

停用被盗用的账号。
在检测到可疑活动后强制重置密码。
在完成员工调动后更新部门信息。
中止不活跃的账号。

操作输入

更新用户操作需要以下参数：

参数	说明
`Email Address`	必填。用于标识要更新哪些用户的以英文逗号分隔的主电子邮件地址列表。
`Given Name`	可选。用户的名字。
`Family Name`	可选。用户的姓氏。
`Password`	可选。新用户的密码。
`Phone`	可选。用户的手机号码。该操作会更新 `custom` 手机号码类型。
`Gender`	可选。用户的性别。有效值如下：`female`、`male`、`other`、`unknown`。
`Department`	可选。用户所在部门的名称。
`Organization`	可选。用户所在组织的名称。
`Change Password At Next Login`	可选。如果选中此选项，系统会要求用户在下次尝试登录时更改密码。默认情况下未选中。
`User Status`	可选。要更新的用户状态。默认情况下，此操作不会更改用户状态。可能的值如下： `Not Changed` `Blocked` `Unblocked`

操作输出

更新用户操作提供以下输出：

操作输出类型	可用性
案例墙附件	不可用
案例墙链接	不可用
“支持请求墙”表格	不可用
丰富化表	不可用
JSON 结果	不可用
输出消息	可用
脚本结果	可用

输出消息

更新用户操作提供以下输出消息：

输出消息消息说明

Successfully updated the following users in Google Workspace: EMAIL_ADDRESSES.

Action wasn't able to update the following users in Google Workspace: EMAIL_ADDRESSES

None of the provided users were updated.

操作成功。

Error executing action "Update User". Reason:
      ERROR_REASON

操作失败。

检查与服务器的连接、输入参数或凭据。

脚本结果

下表介绍了使用更新用户操作时脚本结果输出的值：

脚本结果名称	值
`is_success`	`True` 或 `False`