GAM Google Workspace User Management Scripts

This repository offers Bash scripts that simplify user management in Google Workspace using the GAM and GAMADV-XTD3 command-line tool, automating tasks like onboarding, offboarding, and reporting for consistent and efficient administration.

Prerequisites

1. GAMADV-XTD3: Ensure that GAMADV-XTD3 is installed and configured on your machine.
2. Bash: The scripts are designed to run in a Bash shell environment.

Features

• Onboarding Script (onboard.sh):

  • Creates new user accounts.
  • Sets up email signatures and group memberships.
  • Adds employment details and calendar events.

• Offboarding Script (offboard.sh):

  • Resets passwords and clears recovery options.
  • Transfers Drive and Calendar data.
  • Configures email forwarding and auto-replies.
  • Removes users from groups and hides them from the Global Address List (GAL).

• Reporting Script (print.sh):

  • Generates comprehensive reports including:
    • Organizations
    • Users
    • Groups
    • Aliases
    • Admin roles
    • Calendars
    • Resources
    • Shared Drive ACLs

Setup

1. Install Dependencies: Ensure that all required tools and dependencies are installed. This includes GAM and GAMADV-XTD3, which can be installed using the following commands:

   bash <(curl -s -S -L https://gam-shortn.appspot.com/gam-install)
   bash <(curl -s -S -L https://raw.githubusercontent.com/taers232c/GAMADV-XTD3/master/src/gam-install.sh)

2. Clone the Repository:

   git clone https://github.com/grace-bible/GAM-boarding-scripts.git

3. Configure config.env:

   • Create a config.env file with necessary environment variables such as GAM, GAM3, LOG_DIR, SIG_FILE, CC_HR, BDAY_CAL, and UPDATE_INTERVAL_DAYS.

   Sample config.env

   # This is a configuration file for onboarding and offboarding scripts
   
   GAM=$HOME/bin/gam/gam
   GAM3=$HOME/bin/gamadv-xtd3/gam
   LOG_DIR=/path/to/logs
   SIG_FILE=/path/to/signature/template
   [email protected]
   [email protected]
   GAM_LAST_UPDATE="2000-01-01"
   UPDATE_INTERVAL_DAYS=7

Usage

Onboarding Script

./onboard.sh (-h) [<onboard_first_name> <onboard_last_name> <onboard_user> <manager_email_address> <recovery_email> <campus> <job_title> <birthday>]

Options:

• -h: Print the help message.

Arguments:

1. onboard_first_name: User's first name.
2. onboard_last_name: User's last name.
3. onboard_user: New domain email for the user.
4. manager_email_address: User's manager email.
5. recovery_email: Personal email for the onboarding user.
6. campus: Assigned campus (AND, SW, CRK, MT, SYS).
7. job_title: User's official job title (optional).
8. birthday: User's birthday (YYYY-MM-DD) for the company birthday calendar (optional).

Offboarding Script

./offboard.sh (-h) [<offboard_user> <receiving_user>]

Options:

• -h: Print the help message.

Arguments:

1. offboard_user: User email for the offboarding user.
2. receiving_user: User email for the receiving user of any transfers.

Reporting Script

./print.sh

• Generates various reports on users, groups, calendars, and more.

Notes

• The scripts include interactive menus for selecting and executing tasks.
• The config.env file simplifies personalization of the scripts in one location.
• All scripts check for updates to ensure compatibility with the latest Google Workspace APIs.
• Review and test the scripts in a controlled environment before deploying them in production.
• Feel free to submit issues and pull requests to improve functionality and compatibility.

License

This project is licensed under the MIT License.