gws-cloudidentity

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

cloudidentity (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 cloudidentity <resource> <method> [flags]

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

bash

gws cloudidentity <resource> <method> [flags]

API Resources

API 资源

customers

```
userinvitations
```
— Operations on the 'userinvitations' resource

```
userinvitations
```
— 对'userinvitations'资源执行的操作

devices

```
cancelWipe
```
— Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.
- ```
create
```
  — Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium
- ```
delete
```
  — Deletes the specified device.
- ```
get
```
  — Retrieves the specified device.
- ```
list
```
  — Lists/Searches devices.
- ```
wipe
```
  — Wipes all data on the specified device.
- ```
deviceUsers
```
  — Operations on the 'deviceUsers' resource

```
cancelWipe
```
— 取消未完成的设备擦除操作。该操作可用于在擦除操作返回成功但设备尚未开始擦除的间隙中取消擦除。仅当设备处于“待擦除（pending wipe）”状态时，此操作才有效。当发出设备擦除命令但尚未发送到设备时，设备会进入“待擦除”状态。如果擦除命令已发送至设备，取消擦除操作将失败。
- ```
create
```
  — 创建设备。仅允许创建公司所有的设备。注意：此方法仅对拥有以下SKU的客户开放：Enterprise Standard、Enterprise Plus、Enterprise for Education和Cloud Identity Premium
- ```
delete
```
  — 删除指定设备。
- ```
get
```
  — 获取指定设备的信息。
- ```
list
```
  — 列出/搜索设备。
- ```
wipe
```
  — 擦除指定设备上的所有数据。
- ```
deviceUsers
```
  — 对'deviceUsers'资源执行的操作

groups

```
create
```
— Creates a Group.
- ```
delete
```
  — Deletes a
```
Group
```
  .
- ```
get
```
  — Retrieves a
```
Group
```
  .
- ```
getSecuritySettings
```
  — Get Security Settings
- ```
list
```
  — Lists the
```
Group
```
  resources under a customer or namespace.
- ```
lookup
```
  — Looks up the resource name of a
```
Group
```
  by its
```
EntityKey
```
  .
- ```
patch
```
  — Updates a
```
Group
```
  .
- ```
search
```
  — Searches for
```
Group
```
  resources matching a specified query.
- ```
updateSecuritySettings
```
  — Update Security Settings
- ```
memberships
```
  — Operations on the 'memberships' resource

```
create
```
— 创建身份组（Group）。
- ```
delete
```
  — 删除身份组（Group）。
- ```
get
```
  — 获取身份组（Group）的信息。
- ```
getSecuritySettings
```
  — 获取安全设置
- ```
list
```
  — 列出客户或命名空间下的身份组（Group）资源。
- ```
lookup
```
  — 通过
```
EntityKey
```
  查找身份组（Group）的资源名称。
- ```
patch
```
  — 更新身份组（Group）。
- ```
search
```
  — 搜索符合指定查询条件的身份组（Group）资源。
- ```
updateSecuritySettings
```
  — 更新安全设置
- ```
memberships
```
  — 对'memberships'资源执行的操作

inboundOidcSsoProfiles

```
create
```
— Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the
```
Operation
```
in the response will have
```
"done": false
```
, it will not have a response, and the metadata will have
```
"state": "awaiting-multi-party-approval"
```
.
- ```
delete
```
  — Deletes an InboundOidcSsoProfile.
- ```
get
```
  — Gets an InboundOidcSsoProfile.
- ```
list
```
  — Lists InboundOidcSsoProfile objects for a Google enterprise customer.
- ```
patch
```
  — Updates an InboundOidcSsoProfile. When the target customer has enabled Multi-party approval for sensitive actions, the
```
Operation
```
  in the response will have
```
"done": false
```
  , it will not have a response, and the metadata will have
```
"state": "awaiting-multi-party-approval"
```
  .

```
create
```
— 为客户创建入站OIDC SSO配置文件（InboundOidcSsoProfile）。当目标客户启用了敏感操作多方审批时，响应中的
```
Operation
```
会包含
```
"done": false
```
，不会返回响应内容，且元数据中会包含
```
"state": "awaiting-multi-party-approval"
```
。
- ```
delete
```
  — 删除入站OIDC SSO配置文件（InboundOidcSsoProfile）。
- ```
get
```
  — 获取入站OIDC SSO配置文件（InboundOidcSsoProfile）的信息。
- ```
list
```
  — 列出Google企业客户的入站OIDC SSO配置文件（InboundOidcSsoProfile）。
- ```
patch
```
  — 更新入站OIDC SSO配置文件（InboundOidcSsoProfile）。当目标客户启用了敏感操作多方审批时，响应中的
```
Operation
```
  会包含
```
"done": false
```
  ，不会返回响应内容，且元数据中会包含
```
"state": "awaiting-multi-party-approval"
```
  。

inboundSamlSsoProfiles

```
create
```
— Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the
```
Operation
```
in the response will have
```
"done": false
```
, it will not have a response, and the metadata will have
```
"state": "awaiting-multi-party-approval"
```
.
- ```
delete
```
  — Deletes an InboundSamlSsoProfile.
- ```
get
```
  — Gets an InboundSamlSsoProfile.
- ```
list
```
  — Lists InboundSamlSsoProfiles for a customer.
- ```
patch
```
  — Updates an InboundSamlSsoProfile. When the target customer has enabled Multi-party approval for sensitive actions, the
```
Operation
```
  in the response will have
```
"done": false
```
  , it will not have a response, and the metadata will have
```
"state": "awaiting-multi-party-approval"
```
  .
- ```
idpCredentials
```
  — Operations on the 'idpCredentials' resource

```
create
```
— 为客户创建入站SAML SSO配置文件（InboundSamlSsoProfile）。当目标客户启用了敏感操作多方审批时，响应中的
```
Operation
```
会包含
```
"done": false
```
，不会返回响应内容，且元数据中会包含
```
"state": "awaiting-multi-party-approval"
```
。
- ```
delete
```
  — 删除入站SAML SSO配置文件（InboundSamlSsoProfile）。
- ```
get
```
  — 获取入站SAML SSO配置文件（InboundSamlSsoProfile）的信息。
- ```
list
```
  — 列出客户的入站SAML SSO配置文件（InboundSamlSsoProfile）。
- ```
patch
```
  — 更新入站SAML SSO配置文件（InboundSamlSsoProfile）。当目标客户启用了敏感操作多方审批时，响应中的
```
Operation
```
  会包含
```
"done": false
```
  ，不会返回响应内容，且元数据中会包含
```
"state": "awaiting-multi-party-approval"
```
  。
- ```
idpCredentials
```
  — 对'idpCredentials'资源执行的操作

inboundSsoAssignments

```
create
```
— Creates an InboundSsoAssignment for users and devices in a
```
Customer
```
under a given
```
Group
```
or
```
OrgUnit
```
.
- ```
delete
```
  — Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has
```
sso_mode
```
  ==
```
SSO_OFF
```
  .
- ```
get
```
  — Gets an InboundSsoAssignment.
- ```
list
```
  — Lists the InboundSsoAssignments for a
```
Customer
```
  .
- ```
patch
```
  — Updates an InboundSsoAssignment. The body of this request is the
```
inbound_sso_assignment
```
  field and the
```
update_mask
```
  is relative to that. For example: a PATCH to
```
/v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank
```
  with a body of
```
{ "rank": 1 }
```
  moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.

```
create
```
— 为客户中指定身份组（Group）或组织单元（OrgUnit）下的用户和设备创建入站SSO分配（InboundSsoAssignment）。
- ```
delete
```
  — 删除入站SSO分配（InboundSsoAssignment）。如需禁用SSO，请创建（或更新）一个
```
sso_mode
```
  ==
```
SSO_OFF
```
  的分配。
- ```
get
```
  — 获取入站SSO分配（InboundSsoAssignment）的信息。
- ```
list
```
  — 列出客户的入站SSO分配（InboundSsoAssignment）。
- ```
patch
```
  — 更新入站SSO分配（InboundSsoAssignment）。此请求的主体为
```
inbound_sso_assignment
```
  字段，
```
update_mask
```
  是相对于该字段的。例如：向
```
/v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank
```
  发送PATCH请求，主体为
```
{ "rank": 1 }
```
  ，会将该（以身份组为目标的）SSO分配设置为最高优先级，并将其他以身份组为目标的分配优先级依次下调。

policies

```
get
```
— Get a policy.
- ```
list
```
  — List policies.

```
get
```
— 获取策略。
- ```
list
```
  — 列出策略。

Discovering Commands

命令查询

Before calling any API method, inspect it:

bash

undefined

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

bash

undefined

Browse resources and methods

浏览资源与方法

gws cloudidentity --help

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

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

gws schema cloudidentity.<resource>.<method>


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

gws schema cloudidentity.<resource>.<method>


可借助`gws schema`的输出来构建`--params`和`--json`标志。