Skip to content

Home

Jump to bottom
Ross Scroggs edited this page Nov 16, 2024 · 88 revisions

Introduction

GAM7 is a free, open source command line tool for Google Workspace Administrators to manage domain and user settings quickly and easily.

This page provides simple instructions for downloading, installing and starting to use GAM7.

GAM7 requires paid, or Education/Non-profit, editions of Google Workspace. G Suite Legacy Free Edition has limited API support and not all GAM commands work.

GAM7 is a rewrite/extension of Jay Lee's Legacy GAM, without his efforts, this version wouldn't exist.

GAM7 is backwards compatible with Legacy GAM, meaning that if your command works with Legacy GAM, it will also work with GAM7. There may be differences in output, but the syntax is compatible.

Documentation

Documentation for GAM7 is hosted in the GitHub Wiki and in Gam*.txt files.

Mailing List / Discussion group

The GAM mailing list / discussion group is hosted on Google Groups. You can join the list and interact via email, or just post from the web itself.

Chat Room

There is a public chat room hosted in Google Chat. Instructions to join.

Source Repository

The official GAM7 source repository is on GitHub in the master branch.

Author

GAM is maintained by Jay (James) Lee and Ross Scroggs. Please direct "how do I?" questions to Google Groups.

Requirements

To run all commands properly, GAM7 requires three things:

  • An API project which identifies your install of GAM7 to Google and keeps track of API quotas.
  • Authorization to act as your Google Workspace Administrator in order to perform management functions like add users, modify group settings and membership and pull domain reports.
  • A special service account that is authorized to act on behalf of your users in order to modify user-specific settings and data such as Drive files, Calendars and Gmail messages and settings like signatures.

Installation - First time GAM7 installation

Use these steps if you have never used any version of GAM in your domain. They will create a GAM project and all necessary authentications.

Installation - Upgrading from Legacy GAM

Use these steps if you have used any version of Legacy GAM in your domain. They will update your GAM project and all necessary authentications.

You can install multiple versions of GAM and GAM7 in different parallel directories.

Need more help? Ask on the GAM Discussion Group

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

GAM Tutorials

Clone this wiki locally