与 Google Workspace 同步

对应的官方文档地址

本文将帮助您使用目录连接器将您的 Google Workplace(以前叫 G Suite)中的用户和群组同步到您的 Bitwarden 组织。

Google Workspace 设置

要设置与 Google Workplace(以前叫 G Suite)的目录同步,你需要访问 Google Workspace Admin PortalGoogle Cloud Platform Console。目录连接器需要从这些过程中获得的信息才能正常运行。

创建 Cloud 项目

完成以下步骤来创建用于将连目录连接器连接到您的目录的 Google Cloud 项目。如果您已经有可用的 Google Cloud 项目,请跳至启用Admin SDK

  1. GCP Console 中,选择创建项目按钮。

  2. 为此项目输入一个 Bitwarden 专有名称(比如 bitwarden-dc-project)并选择创建按钮。

启用 Admin SDK

完成以下步骤以启用 Admin SDK API,目录连接器将向其发出请求:

  1. GCP Console 中,选择已创建或已存在的项目。

  2. 从左侧导航中,选择 API 和服务 → 库

  3. 在搜索框中输入 Admin SDK 并打开 Admin SDK API 服务。

  4. 选择启用按钮。

创建服务帐号

完成以下步骤以创建一个在 API 调用时使用的服务账号:

  1. GCP Console 中,选择已创建或已存在的项目。

  2. 从左侧导航中,选择 API 和服务 → 凭据

  3. 选择创建凭据按钮,并从下拉列表中选择服务账号

  4. 填写服务账号详情部分,并选择创建按钮。

  5. 向此服务帐号授予对项目的访问权限部分,从角色下拉列表中选择 Project → Owner 并选择继续按钮。

  6. 选择完成按钮。

获取服务帐号凭据

完成以下步骤,为已创建的服务帐号获取适当的权限:

  1. GCP Console 中,选择已创建或已存在的项目。

  2. 从左侧导航中,选择 IMA 和服务 → 服务账号

  3. 选择已创建的服务账号。

  4. 在服务账号详情页面,选择添加密钥按钮并从下拉列表中选择创建新密钥按钮。

  5. 选择密钥类型为 JSON 并选择创建按钮,将 JSON 格式的密钥下载到您的本地计算机。

  6. 返回您的服务账号的I详情页面,选择显示全网域授权下拉条。

  7. 选中启用全网域授权框。

  8. 输入一个同意屏幕产品名称

  9. 选择保存

允许对 Google Workspace 的读取访问

完成以下步骤以授权客户端读取您的目录:

  1. 从左侧导航中,选择安全 → API 控制

  2. 选择管理全网域授权按钮。

  3. 选择新增按钮。

  4. 粘帖已创建的客户端 ID 到客户端 ID 字段中。 要查看已创建的客户端 ID,请打开 GCP Console 并导航到 API 和服务 → 凭据

  5. 在 OAuth 范围字段中,粘贴以下值以仅授予读取访问权限。

  6. 选择授权按钮。

https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.group.member.readonly

连接到您的目录

完成以下步骤以配置目录连接器使用您的 Google 目录:

  1. 打开目录连接器桌面版应用程序

  2. 导航到 Setting 标签页。

  3. Type 下拉列表中选择 G Suite(Google)。 此部分中的可用字段将根据您选择的类型而变化。

  4. 输入您的 Google 账号的 Domain

  5. 输入对您的 Google 目录具有完全访问权限的 Admin User 的电子邮件地址。

  6. 如果您有,请输入目录的客户 ID。许多用户没有或不需要输入客户 ID。

  7. 选择选择文件按钮并选择已下载的 JSON 密钥文件

  8. Account 部分,从下拉列表中选择要连接到您的目录的组织。

配置同步选项

完成配置后,请导航至 More 标签页,然后选择 Clear Sync Cache 按钮,以防止与先前的同步操作发生潜在冲突。有关更多信息,请参阅清除同步缓存

完成以下步骤以配置当使用目录连接器同步时要使用的设置:

  1. 打开目录连接器桌面版应用程序

  2. 导航到 Setting 标签页。

  3. Sync 部分,根据需要配置如下选项:

选项

描述

Interval

自动同步检查的时间间隔(分钟为单位)。

Remove disabled users during sync

选中此框以从 Bitwarden 组织中删除已在您的组织中禁用的用户。

Overwrite existing organization users based on current sync settings

选中此框以始终执行完全同步,如果任何用户不在同步用户集中,则将其从 Bitwarden 组织中移除。

Sync Users

选中此框以将用户同步到您的组织。

选中此框将允许您指定用户筛选器

User Filter

参阅指定同步筛选器

Sync Groups

选中此框以将群组同步到您的组织。

选中此框将允许您指定群组筛选器

Group Filter

参阅指定同步筛选器

指定同步筛选器

使用逗号分隔的列表可根据用户电子邮件、群组名称或群组成员资格在同步中包含或排除:

用户筛选器

User Filter 字段中使用以下筛选语法:

根据电子邮件包含/排除用户

要基于电子邮件地址在同步中包含或排除特定用户:

使用 query 连接

要将用户筛选器与 query 参数连接起来,请使用竖线(|):

include:[email protected].com,[email protected].com|orgName=Engineering orgTitle:Manager
exclude:[email protected].com,[email protected].com|orgName=Engineering orgTitle:Manager

只使用 query

要只使用 query 参数,请在查询前加上竖线(|):

|orgName=Engineering orgTitle:Manager

群组筛选器

要基于群组名称在同步中包含或排除群组:

include:Group A,Group B
exclude:Group A,Group B

测试同步

要测试目录连接器是否成功连接到您的目录并返回所需的用户和群组,导航到 Dashboard 标签页并选择 Test Now 按钮。如果成功,则用户和群组将根据指定的同步选项筛选器显示在目录连接器窗口中:

测试同步结果

启动自动同步

配置并测试同步选项筛选器后,就可以开始同步了。完成以下步骤以使用目录连接器启动自动同步:

  1. 打开目录连接器桌面版应用程序

  2. 导航到 Dashboard 标签页。

  3. Sync 部分选择 Start Now 按钮。 或者你可以选择 Sync Now 按钮以运行一次性手动同步。

目录连接器将根据配置的同步选项筛选器开始轮询目录。

如果您退出或关闭了目录连接器,自动同步将停止。最小化或隐藏此程序到系统托盘,以保持后台运行。