cloudidentity (v1)
PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to create it.
CODEBLOCK0
API Resources
customers
- userinvitations — Operations on the 'userinvitations' resource
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
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
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".
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
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.
policies
- get — Get a policy.
- list — List policies.
Discovering Commands
Before calling any API method, inspect it:
CODEBLOCK1
Use gws schema output to build your --params and --json flags.
cloudidentity (v1)
前提条件: 请阅读 ../gws-shared/SKILL.md 了解认证、全局标志和安全规则。如果该文件缺失,请运行 gws generate-skills 创建。
bash
gws cloudidentity <资源> <方法> [标志]
API 资源
customers
- userinvitations — 对 userinvitations 资源的操作
devices
- cancelWipe — 取消未完成的设备擦除。此操作可用于在擦除操作返回成功与设备实际被擦除之间的间隙中取消设备擦除。当设备处于待擦除状态时,此操作可行。设备在发出擦除设备命令但尚未发送到设备时进入待擦除状态。如果擦除命令已发送到设备,取消擦除将失败。
- create — 创建设备。仅可创建公司拥有的设备。注意: 此方法仅适用于拥有以下 SKU 之一的客户:Enterprise Standard、Enterprise Plus、Enterprise for Education 和 Cloud Identity Premium
- delete — 删除指定设备。
- get — 检索指定设备。
- list — 列出/搜索设备。
- wipe — 擦除指定设备上的所有数据。
- deviceUsers — 对 deviceUsers 资源的操作
groups
- create — 创建群组。
- delete — 删除一个 Group。
- get — 检索一个 Group。
- getSecuritySettings — 获取安全设置
- list — 列出客户或命名空间下的 Group 资源。
- lookup — 通过 EntityKey 查找 Group 的资源名称。
- patch — 更新一个 Group。
- search — 搜索匹配指定查询的 Group 资源。
- updateSecuritySettings — 更新安全设置
- memberships — 对 memberships 资源的操作
inboundOidcSsoProfiles
- create — 为客户创建 InboundOidcSsoProfile。当目标客户已启用敏感操作的多方审批时,响应中的 Operation 将显示 done: false,不包含响应,且元数据将显示 state: awaiting-multi-party-approval。
- delete — 删除 InboundOidcSsoProfile。
- get — 获取 InboundOidcSsoProfile。
- list — 列出 Google 企业客户的 InboundOidcSsoProfile 对象。
- patch — 更新 InboundOidcSsoProfile。当目标客户已启用敏感操作的多方审批时,响应中的 Operation 将显示 done: false,不包含响应,且元数据将显示 state: awaiting-multi-party-approval。
inboundSamlSsoProfiles
- create — 为客户创建 InboundSamlSsoProfile。当目标客户已启用敏感操作的多方审批时,响应中的 Operation 将显示 done: false,不包含响应,且元数据将显示 state: awaiting-multi-party-approval。
- delete — 删除 InboundSamlSsoProfile。
- get — 获取 InboundSamlSsoProfile。
- list — 列出客户的 InboundSamlSsoProfiles。
- patch — 更新 InboundSamlSsoProfile。当目标客户已启用敏感操作的多方审批时,响应中的 Operation 将显示 done: false,不包含响应,且元数据将显示 state: awaiting-multi-party-approval。
- idpCredentials — 对 idpCredentials 资源的操作
inboundSsoAssignments
- create — 为指定 Group 或 OrgUnit 下的 Customer 中的用户和设备创建 InboundSsoAssignment。
- delete — 删除 InboundSsoAssignment。要禁用 SSO,请创建(或更新)一个 ssomode 为 SSOOFF 的分配。
- get — 获取 InboundSsoAssignment。
- list — 列出 Customer 的 InboundSsoAssignments。
- patch — 更新 InboundSsoAssignment。此请求的主体是 inboundssoassignment 字段,updatemask 相对于该字段。例如:对 /v1/inboundSsoAssignments/0abcdefg1234567&updatemask=rank 执行 PATCH,主体为 { rank: 1 },会将那个(假定针对群组的)SSO 分配移至最高优先级,并将其他针对群组的分配优先级下移。
policies
- get — 获取策略。
- list — 列出策略。
发现命令
在调用任何 API 方法之前,请先检查:
bash
浏览资源和方法
gws cloudidentity --help
检查方法的必需参数、类型和默认值
gws schema cloudidentity.<资源>.<方法>
使用 gws schema 输出来构建你的 --params 和 --json 标志。