cloudidentity (v1)
PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to create it.
gws cloudidentity <resource> <method> [flags]
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:
# 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.
1---2name: gws-cloudidentity3description: Google Cloud Identity: Manage identity groups and memberships.4---56# cloudidentity (v1)78> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.910```bash11gws cloudidentity <resource> <method> [flags]12```1314## API Resources1516### customers1718 - `userinvitations` — Operations on the 'userinvitations' resource1920### devices2122 - `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.23 - `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 Premium24 - `delete` — Deletes the specified device.25 - `get` — Retrieves the specified device.26 - `list` — Lists/Searches devices.27 - `wipe` — Wipes all data on the specified device.28 - `deviceUsers` — Operations on the 'deviceUsers' resource2930### groups3132 - `create` — Creates a Group.33 - `delete` — Deletes a `Group`.34 - `get` — Retrieves a `Group`.35 - `getSecuritySettings` — Get Security Settings36 - `list` — Lists the `Group` resources under a customer or namespace.37 - `lookup` — Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.38 - `patch` — Updates a `Group`.39 - `search` — Searches for `Group` resources matching a specified query.40 - `updateSecuritySettings` — Update Security Settings41 - `memberships` — Operations on the 'memberships' resource4243### inboundOidcSsoProfiles4445 - `create` — Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), 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"`.46 - `delete` — Deletes an InboundOidcSsoProfile.47 - `get` — Gets an InboundOidcSsoProfile.48 - `list` — Lists InboundOidcSsoProfile objects for a Google enterprise customer.49 - `patch` — Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), 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"`.5051### inboundSamlSsoProfiles5253 - `create` — Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), 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"`.54 - `delete` — Deletes an InboundSamlSsoProfile.55 - `get` — Gets an InboundSamlSsoProfile.56 - `list` — Lists InboundSamlSsoProfiles for a customer.57 - `patch` — Updates an InboundSamlSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), 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"`.58 - `idpCredentials` — Operations on the 'idpCredentials' resource5960### inboundSsoAssignments6162 - `create` — Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.63 - `delete` — Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.64 - `get` — Gets an InboundSsoAssignment.65 - `list` — Lists the InboundSsoAssignments for a `Customer`.66 - `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.6768### policies6970 - `get` — Get a policy.71 - `list` — List policies.7273## Discovering Commands7475Before calling any API method, inspect it:7677```bash78# Browse resources and methods79gws cloudidentity --help8081# Inspect a method's required params, types, and defaults82gws schema cloudidentity.<resource>.<method>83```8485Use `gws schema` output to build your `--params` and `--json` flags.86