> ## Documentation Index
> Fetch the complete documentation index at: https://docs.okeanai.ru/llms.txt
> Use this file to discover all available pages before exploring further.

# Gmail Service Account

> Set up Gmail Service Account for the connector

This section walks through setting up the Gmail connector using a Service Account.
More info on Service Accounts can be found [here](https://cloud.google.com/iam/docs/service-account-overview).
A Google Workspace is required.

If you'd rather use an individuals account + OAuth to access Gmail, checkout the section [here](./oauth).

### Authorization

<Steps>
  <Step title="Create Google Cloud Project">
    * [https://console.cloud.google.com/projectcreate](https://console.cloud.google.com/projectcreate)
  </Step>

  <Step title="Enable Gmail API and Admin SDK">
    * 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](https://console.cloud.google.com/flows/enableapi?apiid=gmail.googleapis.com), select your project and enable the **Gmail API**
    * Also enable **Admin SDK API** (search and enable)

    <img className="rounded-image" src="https://mintcdn.com/okeanai/N0GuroOruI14SZsM/assets/admins/connectors/google_drive/GoogleDriveEnableAPI.png?fit=max&auto=format&n=N0GuroOruI14SZsM&q=85&s=03a1822b7236509caa523cf21d141e6d" alt="Google Cloud Console enabling Gmail and Admin SDK APIs" width="808" height="497" data-path="assets/admins/connectors/google_drive/GoogleDriveEnableAPI.png" />
  </Step>

  <Step title="Create Service Account">
    * Go to the [Service Account management page](https://console.cloud.google.com/iam-admin/serviceaccounts) 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 provide it when creating the credential in 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](https://console.cloud.google.com/iam-admin/orgpolicies/iam-disableServiceAccountKeyCreation)
    * Then select `Manage`, select `Override parent's policy` and then select `Not enforced` under `Rules`.
    * Finally, select `SET POLICY`

    <iframe
      width="840"
      height="473"
      src="https://www.youtube.com/embed/Z5R9HUCVVAE?si=GZxteF6rmIHa1BOE"
      title="YouTube video
player"
      frameBorder="0"
      allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope;
picture-in-picture; web-share; fullscreen;"
      allowfullscreen
    />
  </Step>

  <Step title="Grant domain-wide delegation">
    Give this **Service Account** read-only access to Gmail

    * Copy the `Unique ID` of the Service Account
    * Go to the [Domain-wide Delegation page](https://admin.google.com/ac/owl/domainwidedelegation) 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 paste 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`
  </Step>
</Steps>

### Indexing

First, navigate to the Admin Panel and select the Gmail connector.

Then, create a new credential. In the **Authenticate with Onyx** step,
upload the service account key you downloaded when creating the service account.
Each credential holds its own service account key,
so the key is provided here rather than as a single instance-wide upload. For the **Primary Admin Email**,
use the email of a user that has an Admin role in the Google Workspace with access to the **Users > Read** and \*\*Groups

> Read\*\* privileges. This can either be an existing admin, or a brand new account created specifically for Onyx (e.g.
> `onyx-robot@your-domain.com`). Note that this should *NOT* be the service account email.
> This can be configured by an admin in the admin panel of the Google Workspace under Account > Admin roles.

Click **Create Credential**, and then close the dialog. From there,
click the **Continue** button and configure the connector!

<Note>
  You can create more than one Gmail credential on a single Onyx instance, each with its own service account.
  This lets you index multiple Google Workspaces from one Onyx deployment.
  Create a separate credential and connector for each workspace you want to index.
</Note>