Skip to content

fix(services): add admin-directory alias for Admin SDK Directory API#710

Open
nuthalapativarun wants to merge 1 commit intogoogleworkspace:mainfrom
nuthalapativarun:fix/admin-directory-alias
Open

fix(services): add admin-directory alias for Admin SDK Directory API#710
nuthalapativarun wants to merge 1 commit intogoogleworkspace:mainfrom
nuthalapativarun:fix/admin-directory-alias

Conversation

@nuthalapativarun
Copy link
Copy Markdown

Problem

The Admin SDK Directory API (admin/directory_v1) is one of the most commonly used Google Workspace APIs for managing users, groups, and OUs. Accessing it currently requires the unintuitive command:

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

admin-reports implies audit/usage reporting, not directory management. The version override syntax is also non-obvious and not documented anywhere prominent.

Fix

Adds admin-directory and directory as first-class aliases for (admin, directory_v1) in the service registry:

# After this change:
gws admin-directory users list --params '{"domain":"example.com"}'
gws admin-directory groups list --params '{"domain":"example.com"}'
gws admin-directory members list --params '{"groupKey":"group@example.com"}'
gws directory orgunits list --params '{"customerId":"my_customer"}'

The existing admin-reports / reports aliases are unchanged.

Adds unit tests asserting both admin-directory and directory resolve to ("admin", "directory_v1").

Fixes #473

admin-reports implies audit/usage reporting, not user/group management.
Accessing the Directory API currently requires the unintuitive command:

  gws admin-reports --api-version directory_v1 users list ...

Adds admin-directory and directory as first-class aliases for
(admin, directory_v1) so agents and users can discover it naturally:

  gws admin-directory users list --params '{"domain":"example.com"}'
  gws admin-directory groups list --params '{"domain":"example.com"}'

Adds unit tests for both new aliases.

Fixes googleworkspace#473
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 12, 2026

🦋 Changeset detected

Latest commit: 1462c9b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request improves the discoverability and usability of the Admin SDK Directory API within the CLI. By introducing intuitive aliases, it removes the need for users to rely on the less descriptive 'admin-reports' command or complex version overrides, streamlining common administrative tasks.

Highlights

  • Service Aliases: Added 'admin-directory' and 'directory' as new aliases for the Admin SDK Directory API.
  • Testing: Included unit tests to verify that the new aliases correctly resolve to the 'admin/directory_v1' service.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the admin-directory and directory aliases for the Admin SDK Directory API to improve discoverability and separate it from reporting services. It includes a new ServiceEntry in the services configuration and corresponding unit tests to verify the alias resolution. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants