Skip to content
/ gws Public

command line tool for using the Google Workspace Admin (formerly GSuite)

License

Notifications You must be signed in to change notification settings

emicklei/gws

Repository files navigation

gws - command line tool to use the Google Workspace Admin SDK

features

  • list of users
  • details of a user
  • membership of a user
  • management of groups
  • list of roles
  • user assignments of a role
  • list of domains

Any command can produce JSON format using -json at the end of the command.

examples

gws user list
gws user list -limit 4
gws user membership john.doe
gws user membership john.doe@company.com
gws user info john.doe
gws user info john.doe@company.com
gws user aliases john.doe@company.com
gws user suspend angelina "retired"

gws group list    
gws group members all
gws group members all@company.com

gws group info somegroup
gws group info somegroup@company.com
gws group delete my-old@company.com
gws group delete my-old@company.com
gws group add my-group this-person other-person@company.com
gws group remove my-group this-person
gws group export -json > all.json    
gws --domain company.com group export -csv > company-only.csv

gws role list
gws role assignments _USER_MANAGEMENT_ADMIN_ROLE

gws domain list

gws examples

requirements

primary domain access

If your Google Workspace (GSuite) account only has "Group Editor" role then you cannot use the short syntax for accounts that require the lookup of the primary domain. You can workaround this missing permission by setting an enviroment variable such as:

export GWS_PRIMARY_DOMAIN=yourhost.com

install

Installation requires the Go SDK.

go install github.com/emicklei/gws@latest 

tool authentication

  • Using the Google Cloud Platform console, create a new OAuth 2.0 client ID credential in the project for which you enabled the Admin SDK.
  • Download the JSON file from the list of Credentials (download button on the right).
  • Save the file to gws-credentials.json in your home directory or a local directory if you need access to more organisations. gws will look for this file in the current directoy first.

user permissions

gws requires the following authentication scopes to be consent per user. You will be asked to accept those on the first time you use gws. Note that accepting these scopes does not mean you as a user have access ; this is controlled in Cloud Identity (or Google Workspace/GSuite) Admin Console.

See also https://developers.google.com/admin-sdk/directory/v1/guides/authorizing

help

Having problems using gws ? Read about known errors

© 2023+, ernestmicklei.com. MIT License. Contributions welcome.