This section walks through setting up the Gmail connector using a Service Account. More info on Service Accounts can be found here. A Google Workspace is required.

If you’d rather use an individuals account + OAuth to access Gmail, checkout the section here.

​

Authorization

1. Create a Google Cloud Project

   • https://console.cloud.google.com/projectcreate

2. Enable the Gmail API

   • On the left panel, open APIs & services
   • Go to Enabled APIs and services
   • On the top click +ENABLE APIS AND SERVICES
   • Search for Gmail API and click ENABLE
   • Alternatively visit this link, select your project and enable the Gmail API

3. Enable the Admin SDK API

   • Click on +ENABLE APIS AND SERVICES again.
   • Search for Admin SDK API and click ENABLE
   • Alternatively visit this link, select your project and enable the Admin SDK API

4. Create a Service Account

   • Go to the Service Account management page in Google Cloud.
   • Click Create Service Account button and fill out the fields in step 1. You can ignore steps 2 and 3.
   • Go to the Keys section, and click Add Key. Download this key, you will need to upload to to Onyx later.

   Note for Google Organizations created after April 2024:

   • to give the service account the proper permissions you will have to navigate to this link
   • Then select Manage, select Override parent's policy and then select Not enforced under Rules.
   • Finally, select SET POLICY

5. Give this Service Account read-only access to Gmail
   • Copy the Unique ID of the Service Account
   • Go to the Domain-wide Delegation page in the Google Admin Console.
   • Click Add new, fill in the client ID with the Unique ID of the Service account
   • Copy this comma separated list of scopes and pasted it into field OAuth scopes: https://www.googleapis.com/auth/gmail.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly