SuperAPI AI 工具集

gws-admin

办公与效率

查看项目

更新于 10-15 20:21

技能介绍

gws-admin 是 Google Workspace Admin SDK(directory_v1)的命令行封装,用于通过 gws 命令对 Google Workspace 目录进行管理。它面向需要以脚本或命令行方式管理 Workspace 用户、群组和设备的场景。

用途 该工具提供对 Admin SDK directory_v1 各资源的访问,可用于管理用户、群组、组织单位、Chrome OS 设备、移动设备、角色与权限、域名与域名别名、验证码、两步验证等。

前置条件 使用前需阅读 ../gws-shared/SKILL.md,了解认证方式、全局参数和安全规则。若该文件缺失,可运行 gws generate-skills 生成。

使用方式 基本调用格式为:gws admin <resource> <method> [flags]。 在调用任何 API 方法前,可先查看帮助与结构:

  • 浏览资源与方法:gws admin --help
  • 查看某方法的必填参数、类型与默认值:gws schema admin.<resource>.<method> 然后根据 gws schema 的输出构建 --params 和 --json 参数。

主要能力(按资源)

  • asps:删除、获取、列出用户签发的 ASP。
  • channels:停止通过该频道监视资源。
  • chromeosdevices:对 Chrome OS 设备执行操作(建议改用 BatchChangeChromeOsDeviceStatus),包括取消配置、禁用、重新启用;获取设备属性;分页列出账户内设备;将最多 50 台设备移动或插入到组织单位;更新设备可更新属性(如 annotatedUser、annotatedLocation、notes、orgUnitPath、annotatedAssetId),支持 patch 语义。
  • customer:devices 资源相关操作。
  • customers:获取、修补、更新客户。
  • chrome:chrome 资源相关操作。
  • domainAliases:删除、获取、插入、列出客户的域名别名。
  • domains:删除、获取、插入、列出客户的域名。
  • groups:删除、获取、创建、分页列出(按域或按 userKey)、修补、更新群组;aliases 资源相关操作;members 资源支持移除成员、获取成员属性、检查成员关系(直接或嵌套,嵌套时 memberKey 与 groupKey 须同域,否则返回 Invalid input;跨域嵌套检查需使用 Cloud Identity Groups API 的 checkTransitiveMembership())、添加用户、分页列出成员(60 分钟超时)、修补、更新成员关系。
  • mobiledevices:对移动设备执行操作(如远程擦除)、删除、获取属性、分页列出账户内用户自有移动设备(60 分钟超时;含公司自有设备需改用 Cloud Identity Devices API)。
  • orgunits:删除、获取、添加、列出、修补、更新组织单位。
  • privileges:分页列出客户的所有权限。
  • resources:buildings、calendars、features 资源相关操作。
  • roleAssignments:删除、获取、创建、分页列出角色分配。
  • roles:删除、获取、创建、分页列出域内角色、修补、更新角色。
  • schemas:删除、获取、创建、列出客户所有 schema、修补、更新 schema。
  • tokens:删除用户为某应用签发的所有访问令牌、获取某访问令牌信息、列出用户签发给第三方应用的令牌集合。
  • twoStepVerification:关闭用户的两步验证。
  • users:创建访客用户(Alpha 阶段,需联系支持);删除、获取、创建用户(创建后立即变更调用可能因后端传播延迟失败,可检查错误详情中的“User creation is not complete”并稍后重试;若 resolveConflictAccount 为 true,202 响应表示存在冲突的非托管账户并已邀请加入组织);分页列出已删除用户或域内所有用户;将用户设为超级管理员;使用 patch 语义更新用户(建议改用 update,因其同样支持 patch 语义且性能更好;映射外部身份到 Google 身份时应使用 update;patch 无法清空包含重复对象的字段,如 addresses、phones 等);将用户从所有网页和设备会话中登出并重置登录 cookie;恢复已删除用户;更新用户(支持 patch 语义,未提供的字段保留,设为 null 的字段清空;数组类重复字段不能逐项修补,须在请求体中提供所有项的期望值);监视用户列表变更;aliases、photos 资源相关操作;verificationCodes 支持生成、作废、列出用户的备用验证码。

适用场景 适用于需要通过命令行或脚本批量管理 Google Workspace 目录对象的场景,例如用户与群组维护、设备管理、角色与权限配置、域名管理、安全相关操作(登出、两步验证、令牌管理)等。

限制

  • 使用前必须完成 gws-shared 中的认证与安全配置。
  • 部分方法有超时限制(如成员列表、移动设备列表为 60 分钟)。
  • 部分功能处于 Alpha 阶段(如 createGuest),需联系支持。
  • 某些操作有替代建议(如 chromeosdevices.action 建议改用 BatchChangeChromeOsDeviceStatus;users.patch 建议改用 users.update)。
  • 嵌套成员关系检查受域限制,跨域需使用 Cloud Identity Groups API。
  • 用户创建后可能存在传播延迟,导致后续调用失败。
  • 具体收费、价格、平台支持等信息暂未提供。