GAM is a command-line tool for manipulating Google Apps accounts. It is written in Python, and uses Google’s gdata Python module.

GAM is documented at http://code.google.com/p/google-apps-manager/. The gdata Python module is documented at http://code.google.com/p/gdata-python-client/.

Installing GAM
When you install GAM, it installs the gam.py Python script, and the gdata module in its own directory. See instructions on the GAM page linked above.

Configuring GAM
To use GAM, you need to configured it to use your Google Apps Management credentials. This involves running this on the command-line;

python gam.py info domain

This will guide you through the process, during which your web browser will open to a page on Google Apps where you can verify certain information. The link to GAM above explains the details. Once you have authenticated, a credentials file called oauth.txt is created in the current directory. Future invocations of python gam.py will automatically load and use the credentials in oauth.txt.

Using GAM
Once you have configured gam.py to automatically authenticate when run, you can run gam.py with a number of parameters. For example, to get information on the user joe.user, you could do this

python gam.py info user joe.user@uconn.edu

and see something like this

User: joe.user
First Name: Joe
Last Name: User
Is an admin: false
Has agreed to terms: true
IP Whitelisted: false
Account Suspended: false
Must Change Password: false
Email Aliases (Nicknames):
Groups:

---