Groups Settings
Groups Settings has 2 operations in gum's generated catalog. Start with search when you know the task, use describe to inspect request fields and scopes, then dispatch through the command that matches the operation risk class.
| Count | Value |
|---|---|
| Family | Workspace administration |
| Operations | 2 |
| Risk classes | 1 read, 1 write |
| Auth strategies | 2 byo_oauth |
Start here
gum search "groups settings"
gum describe groupssettings.groups.get
gum read groupssettings.groups.get --args '{"groupUniqueId":"<groupUniqueId>"}' --output jsonFor write-class operations, gum requires the write command and an explicit write gate:
gum describe groupssettings.groups.update
gum write groupssettings.groups.update --allow-write --args '{"groupUniqueId":"<groupUniqueId>"}'Auth
Auth strategies in this service: 2 byo_oauth. Authenticate the strategy used by the operation you plan to call.
Bring-your-own OAuth
- In Google Cloud, enable Groups Settings API.
- Configure the OAuth consent screen. Add your Google account as a test user when the app is still in testing mode.
- Create an OAuth client ID with application type
Desktop app. - Add the scopes this service needs to the consent screen.
- Store the client in gum:
printf '%s' "$GOOGLE_OAUTH_CLIENT_SECRET" \
| gum auth use-oauth-client --client-id "$GOOGLE_OAUTH_CLIENT_ID" --secret-stdin- Authorize this service:
gum login --service groupssettings- Verify the grant before dispatch:
gum auth status --scopes apps.groups.settings
gum describe groupssettings.groups.getScopes used by these operations:
https://www.googleapis.com/auth/apps.groups.settings
Service setup notes: Groups Settings auth guide.
Operations
| Operation | Risk | Auth | Summary |
|---|---|---|---|
groupssettings.groups.get |
read |
byo_oauth |
Fetch a Workspace group's settings by email (groupUniqueId): posting permissions, join policy, archiving, etc. |
groupssettings.groups.update |
write |
byo_oauth |
Replace a Workspace group's settings (args.body). |
Next
- Use API workflows for search, describe, invoke, and error handling.
- Use Auth guides for service-specific Google setup.
- Use Command index for CLI flags and generated help.
