在调用 Mail Admin Quarantine API 之前,请先完成本页中的步骤,以启用该 API、找到每个请求所需的标识符,并在您的 Google Workspace 账号中授予所需的管理员权限。
前提条件
- 拥有管理员隔离区功能的 Google Workspace 账号。如需了解详情,请参阅设置和管理电子邮件隔离区。
- Google Cloud 项目。如需创建项目,请参阅创建项目。
- Google Workspace 开发者预览版计划的成员资格。 您的云项目必须先加入该计划,然后才能调用 Admin Quarantine API。
- 以超级用户身份访问 Google 管理控制台,以授予管理员权限并授权全网域委派。
启用 API
在托管集成的云项目中启用 mailadminquarantine.googleapis.com。
控制台
在 Google Cloud 控制台中,启用 Mail Admin Quarantine API。
gcloud
运行以下命令,将 PROJECT_ID 替换为您的云项目 ID:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
查找您的客户 ID
对 Admin Quarantine API 的每个请求都会使用 customers/CUSTOMER_ID 资源名称标识您的 Google Workspace 账号。
如需查找您的客户 ID,请执行以下操作:
- 以管理员身份登录管理控制台。
- 依次前往账号 > 账号设置 > 个人资料。
- 复制客户 ID。
如果客户 ID 以 C 开头,请移除 C,并在资源名称中使用剩余的字母数字值,例如 customers/01abc23de。请勿将域名用作客户 ID。
如需了解详情,请参阅查找客户 ID。
授予所需的管理员权限
Admin Quarantine API 会执行与管理控制台中的管理员隔离区相同的管理员权限检查。每个请求都代表 Google Workspace 管理员运行,并且该管理员必须拥有以下 Gmail 权限之一:
| 私人定制游 | 允许执行的操作 |
|---|---|
| 访问管理员隔离区 | 访问和管理所有隔离区(包括默认隔离区)中的邮件。 |
| 访问受限的隔离区 | 只能访问和管理与管理员所属群组关联的隔离区中的邮件。 |
超级用户会自动拥有这些权限。对于其他管理员,请分配包含该权限的角色:
- 以超级用户身份登录管理控制台。
- 前往账号 > 管理员角色。
- 选择现有角色或点击创建新角色。
- 在权限标签页中,前往服务 > Gmail,然后选择访问管理员隔离区或访问受限的隔离区。
- 将该角色分配给您的集成在调用 API 时模拟的管理员账号。
如需详细了解受托管理员角色,请参阅在 Gmail 中委派管理员权限和管理员权限定义。
如果被模拟的管理员没有所需的权限,则 API 会返回 403 PERMISSION_DENIED 错误。