gws-admin

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

admin (directory_v1)

PREREQUISITE: Read
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run
gws generate-skills
to create it.

bash

gws admin <resource> <method> [flags]

前置要求： 请阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果该文件缺失，请运行
gws generate-skills
生成它。

bash

gws admin <resource> <method> [flags]

API Resources

API资源

asps

```
delete
```
— Deletes an ASP issued by a user.
- ```
get
```
  — Gets information about an ASP issued by a user.
- ```
list
```
  — Lists the ASPs issued by a user.

```
delete
```
— 删除用户签发的ASP。
- ```
get
```
  — 获取用户签发的ASP相关信息。
- ```
list
```
  — 列出用户签发的所有ASP。

channels

```
stop
```
— Stops watching resources through this channel.

```
stop
```
— 停止通过该通道监控资源。

chromeosdevices

```
action
```
— Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled.
- ```
get
```
  — Retrieves a Chrome OS device's properties.
- ```
list
```
  — Retrieves a paginated list of Chrome OS devices within an account.
- ```
moveDevicesToOu
```
  — Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
- ```
patch
```
  — Updates a device's updatable properties, such as
```
annotatedUser
```
  ,
```
annotatedLocation
```
  ,
```
notes
```
  ,
```
orgUnitPath
```
  , or
```
annotatedAssetId
```
  . This method supports patch semantics.
- ```
update
```
  — Updates a device's updatable properties, such as
```
annotatedUser
```
  ,
```
annotatedLocation
```
  ,
```
notes
```
  ,
```
orgUnitPath
```
  , or
```
annotatedAssetId
```
  .

```
action
```
— 请改用BatchChangeChromeOsDeviceStatus。执行影响Chrome OS设备的操作，包括取消配置、禁用和重新启用设备。警告： 取消设备配置将停止设备策略同步并移除设备级打印机。设备取消配置后，必须先擦除才能重新注册。
- ```
get
```
  — 获取Chrome OS设备的属性信息。
- ```
list
```
  — 获取账号内Chrome OS设备的分页列表。
- ```
moveDevicesToOu
```
  — 将多台Chrome OS设备移动或添加到组织单元，单次最多可移动50台设备。
- ```
patch
```
  — 更新设备的可修改属性，例如
```
annotatedUser
```
  、
```
annotatedLocation
```
  、
```
notes
```
  、
```
orgUnitPath
```
  或
```
annotatedAssetId
```
  。该方法支持补丁语义。
- ```
update
```
  — 更新设备的可修改属性，例如
```
annotatedUser
```
  、
```
annotatedLocation
```
  、
```
notes
```
  、
```
orgUnitPath
```
  或
```
annotatedAssetId
```
  。

customer

```
devices
```
— Operations on the 'devices' resource

```
devices
```
— 对'devices'资源的操作

customers

```
get
```
— Retrieves a customer.
- ```
patch
```
  — Patches a customer.
- ```
update
```
  — Updates a customer.
- ```
chrome
```
  — Operations on the 'chrome' resource

```
get
```
— 获取客户信息。
- ```
patch
```
  — 补丁更新客户信息。
- ```
update
```
  — 更新客户信息。
- ```
chrome
```
  — 对'chrome'资源的操作

domainAliases

```
delete
```
— Deletes a domain Alias of the customer.
- ```
get
```
  — Retrieves a domain alias of the customer.
- ```
insert
```
  — Inserts a domain alias of the customer.
- ```
list
```
  — Lists the domain aliases of the customer.

```
delete
```
— 删除客户的域名别名。
- ```
get
```
  — 获取客户的域名别名信息。
- ```
insert
```
  — 添加客户的域名别名。
- ```
list
```
  — 列出客户的所有域名别名。

domains

```
delete
```
— Deletes a domain of the customer.
- ```
get
```
  — Retrieves a domain of the customer.
- ```
insert
```
  — Inserts a domain of the customer.
- ```
list
```
  — Lists the domains of the customer.

```
delete
```
— 删除客户的域名。
- ```
get
```
  — 获取客户的域名信息。
- ```
insert
```
  — 添加客户的域名。
- ```
list
```
  — 列出客户的所有域名。

groups

```
delete
```
— Deletes a group.
- ```
get
```
  — Retrieves a group's properties.
- ```
insert
```
  — Creates a group.
- ```
list
```
  — Retrieves all groups of a domain or of a user given a userKey (paginated).
- ```
patch
```
  — Updates a group's properties. This method supports patch semantics.
- ```
update
```
  — Updates a group's properties.
- ```
aliases
```
  — Operations on the 'aliases' resource

```
delete
```
— 删除群组。
- ```
get
```
  — 获取群组的属性信息。
- ```
insert
```
  — 创建群组。
- ```
list
```
  — 获取某个域名或某个用户（通过userKey指定）的所有群组分页列表。
- ```
patch
```
  — 更新群组的属性信息。该方法支持补丁语义。
- ```
update
```
  — 更新群组的属性信息。
- ```
aliases
```
  — 对'aliases'资源的操作

members

```
delete
```
— Removes a member from a group.
- ```
get
```
  — Retrieves a group member's properties.
- ```
hasMember
```
  — Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the
```
memberKey
```
  and
```
groupKey
```
  must be entities in the same domain or an
```
Invalid input
```
  error is returned. To check for nested memberships that include entities outside of the group's domain, use the
```
checkTransitiveMembership()
```
  method in the Cloud Identity Groups API.
- ```
insert
```
  — Adds a user to the specified group.
- ```
list
```
  — Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.
- ```
patch
```
  — Updates the membership properties of a user in the specified group. This method supports patch semantics.
- ```
update
```
  — Updates the membership of a user in the specified group.

```
delete
```
— 将成员从群组中移除。
- ```
get
```
  — 获取群组成员的属性信息。
- ```
hasMember
```
  — 检查指定用户是否为群组成员，成员关系可以是直接或嵌套的，但如果是嵌套关系，
```
memberKey
```
  和
```
groupKey
```
  必须属于同一域名，否则会返回“Invalid input”错误。要检查包含群组域名外实体的嵌套成员关系，请使用Cloud Identity Groups API中的
```
checkTransitiveMembership()
```
  方法。
- ```
insert
```
  — 将用户添加到指定群组。
- ```
list
```
  — 获取群组内所有成员的分页列表。该方法会在60分钟后超时，更多信息请参见错误代码排查。
- ```
patch
```
  — 更新指定群组内用户的成员属性。该方法支持补丁语义。
- ```
update
```
  — 更新指定群组内用户的成员关系。

mobiledevices

```
action
```
— Takes an action that affects a mobile device. For example, remotely wiping a device.
- ```
delete
```
  — Removes a mobile device.
- ```
get
```
  — Retrieves a mobile device's properties.
- ```
list
```
  — Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity Devices API instead. This method times out after 60 minutes. For more information, see Troubleshoot error codes.

```
action
```
— 执行影响移动设备的操作，例如远程擦除设备。
- ```
delete
```
  — 移除移动设备。
- ```
get
```
  — 获取移动设备的属性信息。
- ```
list
```
  — 获取账号内所有用户自有移动设备的分页列表。如果要获取包含公司自有设备的列表，请改用Cloud Identity 设备API。该方法会在60分钟后超时，更多信息请参见错误代码排查。

orgunits

```
delete
```
— Removes an organizational unit.
- ```
get
```
  — Retrieves an organizational unit.
- ```
insert
```
  — Adds an organizational unit.
- ```
list
```
  — Retrieves a list of all organizational units for an account.
- ```
patch
```
  — Updates an organizational unit. This method supports patch semantics
- ```
update
```
  — Updates an organizational unit.

```
delete
```
— 移除组织单元。
- ```
get
```
  — 获取组织单元信息。
- ```
insert
```
  — 添加组织单元。
- ```
list
```
  — 获取账号内所有组织单元的列表。
- ```
patch
```
  — 更新组织单元信息。该方法支持补丁语义
- ```
update
```
  — 更新组织单元信息。

privileges

```
list
```
— Retrieves a paginated list of all privileges for a customer.

```
list
```
— 获取客户所有权限的分页列表。

resources

```
buildings
```
— Operations on the 'buildings' resource
- ```
calendars
```
  — Operations on the 'calendars' resource
- ```
features
```
  — Operations on the 'features' resource

```
buildings
```
— 对'buildings'资源的操作
- ```
calendars
```
  — 对'calendars'资源的操作
- ```
features
```
  — 对'features'资源的操作

roleAssignments

```
delete
```
— Deletes a role assignment.
- ```
get
```
  — Retrieves a role assignment.
- ```
insert
```
  — Creates a role assignment.
- ```
list
```
  — Retrieves a paginated list of all roleAssignments.

```
delete
```
— 删除角色分配。
- ```
get
```
  — 获取角色分配信息。
- ```
insert
```
  — 创建角色分配。
- ```
list
```
  — 获取所有角色分配的分页列表。

roles

```
delete
```
— Deletes a role.
- ```
get
```
  — Retrieves a role.
- ```
insert
```
  — Creates a role.
- ```
list
```
  — Retrieves a paginated list of all the roles in a domain.
- ```
patch
```
  — Patches a role.
- ```
update
```
  — Updates a role.

```
delete
```
— 删除角色。
- ```
get
```
  — 获取角色信息。
- ```
insert
```
  — 创建角色。
- ```
list
```
  — 获取域名内所有角色的分页列表。
- ```
patch
```
  — 补丁更新角色信息。
- ```
update
```
  — 更新角色信息。

schemas

```
delete
```
— Deletes a schema.
- ```
get
```
  — Retrieves a schema.
- ```
insert
```
  — Creates a schema.
- ```
list
```
  — Retrieves all schemas for a customer.
- ```
patch
```
  — Patches a schema.
- ```
update
```
  — Updates a schema.

```
delete
```
— 删除架构。
- ```
get
```
  — 获取架构信息。
- ```
insert
```
  — 创建架构。
- ```
list
```
  — 获取客户的所有架构。
- ```
patch
```
  — 补丁更新架构信息。
- ```
update
```
  — 更新架构信息。

tokens

```
delete
```
— Deletes all access tokens issued by a user for an application.
- ```
get
```
  — Gets information about an access token issued by a user.
- ```
list
```
  — Returns the set of tokens specified user has issued to 3rd party applications.

```
delete
```
— 删除用户为某应用签发的所有访问令牌。
- ```
get
```
  — 获取用户签发的访问令牌信息。
- ```
list
```
  — 返回指定用户向第三方应用签发的所有令牌集合。

twoStepVerification

```
turnOff
```
— Turns off 2-Step Verification for user.

```
turnOff
```
— 关闭用户的两步验证。

users

```
createGuest
```
— Create a guest user with access to a subset of Workspace capabilities. This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.
- ```
delete
```
  — Deletes a user.
- ```
get
```
  — Retrieves a user.
- ```
insert
```
  — Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If
```
resolveConflictAccount
```
  is set to
```
true
```
  , a
```
202
```
  response code means that a conflicting unmanaged account exists and was invited to join the organization.
- ```
list
```
  — Retrieves a paginated list of either deleted users or all users in a domain.
- ```
makeAdmin
```
  — Makes a user a super administrator.
- ```
patch
```
  — Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the
```
update
```
  method instead of the
```
patch
```
  method. This method is unable to clear fields that contain repeated objects (
```
addresses
```
  ,
```
phones
```
  , etc). Use the update method instead.
- ```
signOut
```
  — Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.
- ```
undelete
```
  — Undeletes a deleted user.
- ```
update
```
  — Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to
```
null
```
  will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items.
- ```
watch
```
  — Watches for changes in users list.
- ```
aliases
```
  — Operations on the 'aliases' resource
- ```
photos
```
  — Operations on the 'photos' resource

```
createGuest
```
— 创建访客用户，可访问部分Workspace功能。该功能目前处于Alpha测试阶段。如果您有兴趣试用，请联系支持人员。
- ```
delete
```
  — 删除用户。
- ```
get
```
  — 获取用户信息。
- ```
insert
```
  — 创建用户。用户创建后立即执行的修改调用有时可能会失败，这是因为后端传播延迟导致用户尚未完全创建。如果错误详情中包含“User creation is not complete”消息，则属于这种情况。等待一段时间后重试调用即可解决。如果
```
resolveConflictAccount
```
  设置为
```
true
```
  ，返回
```
202
```
  状态码表示存在冲突的非托管账号，且已邀请该账号加入组织。
- ```
list
```
  — 获取已删除用户或域名内所有用户的分页列表。
- ```
makeAdmin
```
  — 将用户设为超级管理员。
- ```
patch
```
  — 使用补丁语义更新用户信息。建议改用update方法，因为它也支持补丁语义且性能更好。如果您要将外部身份映射到Google身份，请使用
```
update
```
  方法而非
```
patch
```
  方法。该方法无法清除包含重复对象的字段（如
```
addresses
```
  、
```
phones
```
  等），请改用update方法。
- ```
signOut
```
  — 让用户退出所有网页和设备会话，并重置其登录Cookie。用户需要重新认证才能登录。
- ```
undelete
```
  — 恢复已删除的用户。
- ```
update
```
  — 更新用户信息。该方法支持补丁语义，即您只需包含想要更新的字段。请求中未包含的字段将保留原值，设置为
```
null
```
  的字段将被清除。对于包含数组的重复字段，无法单独修补数组中的单个项；必须在请求正文中提供所有项的所需值。
- ```
watch
```
  — 监控用户列表的变化。
- ```
aliases
```
  — 对'aliases'资源的操作
- ```
photos
```
  — 对'photos'资源的操作

verificationCodes

```
generate
```
— Generates new backup verification codes for the user.
- ```
invalidate
```
  — Invalidates the current backup verification codes for the user.
- ```
list
```
  — Returns the current set of valid backup verification codes for the specified user.

```
generate
```
— 为用户生成新的备份验证码。
- ```
invalidate
```
  — 作废用户当前的备份验证码。
- ```
list
```
  — 返回指定用户当前有效的所有备份验证码集合。

Discovering Commands

命令探索

Before calling any API method, inspect it:

bash

undefined

调用任何API方法前，请先查看其详情：

bash

undefined

Browse resources and methods

浏览资源和方法

gws admin --help

Inspect a method's required params, types, and defaults

查看方法的必填参数、类型和默认值

gws schema admin.<resource>.<method>


Use `gws schema` output to build your `--params` and `--json` flags.

gws schema admin.<resource>.<method>


使用`gws schema`的输出来构建您的`--params`和`--json`标志。