Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add admin-directory as a built-in service alias for Admin SDK Directory API

Open Beginner friendly
  • Is something wrong?
#473 1 comment 5 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
82/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust
Domain
cli

Research direction

Start in src/services.rs and compare the existing admin-reports ServiceEntry with the proposed admin-directory entry. Verify that the alias resolves to admin:directory_v1 and that the documented Directory commands work; done means the new alias is available without changing existing aliases.

Written by the indexing model from the issue text.

Description

Summary

The Admin SDK Directory API (admin:directory_v1) is one of the most commonly used Google Workspace APIs for managing users, groups, and organizational units. Currently, accessing it through gws requires using the admin-reports alias with a version override:

gws admin-reports --api-version directory_v1 groups list --params '{"domain":"example.com"}'

This works but is unintuitive — admin-reports implies audit/usage reporting, not user/group management. A built-in admin-directory alias would make the CLI more discoverable and self-documenting.

Proposed Change

Add a new ServiceEntry to src/services.rs:

ServiceEntry {
    aliases: &["admin-directory"],
    api_name: "admin",
    version: "directory_v1",
    description: "Manage users, groups, and organizational units",
},

This would enable:

gws admin-directory groups list --params '{"domain":"example.com"}'
gws admin-directory members list --params '{"groupKey":"[email protected]"}'
gws admin-directory users get --params '{"userKey":"[email protected]"}'

Context

  • The admin-reports alias already maps to admin:reports_v1 — same API name, different version
  • The --api-version directory_v1 workaround works correctly today
  • Adding this alias is backward-compatible (no existing aliases change)
  • The Directory API is core to Workspace administration and used heavily for RBAC, onboarding/offboarding, and compliance workflows
Dominant language
Rust
Stars
31.2k
Forks
1.9k
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from googleworkspace/cli

All issues in googleworkspace/cli

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.