gws-admin

Files (1)

• SKILL.md

SKILL.md (first lines)

# 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]
```

## API Resources

### 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.

### channels

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

### chromeosdevices

  - `action` — Use [BatchChangeChromeOsDeviceStatus](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) 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](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
  - `update` — Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.

### customer

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

### customers

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

### 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.

### 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.

### 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](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
  - `update` — Updates a group's properties.
  - `aliases` — Operations on the 'aliases' resource

### 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()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/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](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
  - `patch` — Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
  - `update` — Updates the membership of a user in the specified group.

### 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](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).

### 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](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)
  - `update` — Updates an organizational unit.

### privileges

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

### resources

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

### roleAssignments

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

### 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.

### schemas

  - `delete` — Deletes a schema.

From niclasmartinsson-sys/google-workspace-cli, Apache-2.0.

More from niclasmartinsson-sys/google-workspace-cli