Google Drive

​

Overview

​

Authentication

​

How to configure and enable the Google Drive Connector

​

Step 1: Create a Google Cloud Project & Set Up Admin Access

1. Sign in as Super Administrator:
   Log in to the Google Cloud Console using an account with super administrator privileges.
2. Create a New Project:
   • Click on the project dropdown at the top of the console and select New Project
   • Enter a project name and (optionally) assign it to a folder or organization
   • Click Create

​

Step 2: Enable Required APIs

1. Navigate to APIs & Services > Library in the Cloud Console
2. Search for and enable the following APIs required for Google Drive sync:
   • Google Drive API (required for Drive file access)
   • Google Docs API (required for Google Docs files)
   • Google Sheets API (required for Google Sheets files)
   • Google Slides API (required for Google Slides files)
   • Admin SDK API (required for domain-wide delegation)

​

Step 3: Create a Service Account

1. Navigate to IAM & Admin > Service Accounts in the Cloud Console
2. Click Create Service Account

3. Enter a Service Account Name and an optional Description
4. Click Create and Continue, then Done

5. Copy the Unique ID for use in the next step

​

Step 4: Delegate Domain-Wide Authority

1. Sign in to the Google Admin Console with a super administrator account
2. Navigate to Security > Access and data control > API controls
3. Click Manage Domain Wide Delegation
4. Click Add new and paste the service account’s client ID
5. Add the following OAuth scopes required for Google Drive sync:

https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.reports.audit.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.domain.readonly,https://www.googleapis.com/auth/admin.directory.orgunit,https://www.googleapis.com/auth/drive.readonly,https://www.googleapis.com/auth/drive.metadata.readonly,https://www.googleapis.com/auth/drive.metadata,https://www.googleapis.com/auth/documents.readonly,https://www.googleapis.com/auth/spreadsheets.readonly,https://www.googleapis.com/auth/presentations.readonly,https://www.googleapis.com/auth/drive.file,https://www.googleapis.com/auth/drive

6. Click Authorize

​

Step 5: Create a JSON Key for the Service Account

1. In the Service Accounts list, select your newly created service account
2. Click on the Keys tab
3. Click Add Key and select Create new key
4. Choose JSON as the key type and click Create
5. Save the automatically downloaded JSON key file

It might be that while creating the key you get the error:

In this case, follow the steps given under the heading Enable Service Account Key Creation.
If your key was successfully created and downloaded, you can use that key in the enterprise search application.

​

Configuring and enabling connector

1. Navigate to the Connectors page in your account settings:
   • Go to Account > Company Settings > Settings > Connectors

2. Click on “Add New Connectors” or “Browse Available Connectors” view available connectors

3. Find and click on the Google Drive connector card to create a new connector instance
4. In the configuration dialog that opens:
   • Enter an Instance Name for your connector (e.g., “Company Drive”)
   • Enter the Admin Email (Admin user’s email with which you created the Google Cloud credentials)
   • Select the JSON key file to upload
   • Click on Save button to save the configuration

5. After saving, you will be redirected to the connector instance page. To enable the connector:
   • Use the Sync toggle switch to enable data synchronization
   • The connector will start syncing Google Drive data once enabled

​

Enable Service Account Key Creation

​

1. Switch to the Organization Context

​

2. Add Organisation Policy Administrator Role

​

3. Disable the Service Account Key Creation constraint

​

Google PubSub Configuration

​

Step 1: Set Up a Cloud Pub/Sub Topic

1. Navigate to Pub/Sub > Topics in the Cloud Console sidebar
2. Click Create Topic
3. Enter a unique name (e.g., projects/your-project-id/topics/drive-webhook-topic)
4. Check “Add a default subscription”
5. Click Create to confirm

​

Step 2: Configure the Subscription

1. Go to Pub/Sub > Topics
2. Select the subscription created with the topic
3. Click Edit
4. Change Delivery type to “Push”
5. Set Endpoint URL as “your_base_url/drive/webhook”
6. Adjust Expiry Period as needed
7. Click Update

​

Step 3: Set Topic Permissions

1. In Pub/Sub > Topics, select your topic
2. Open the Info Panel (right side)
3. Click Add Principals
4. Add [email protected]
5. Assign the Pub/Sub Publisher role

6. Click Save

​

Overview

​

Authentication

​

Step 1: Create a Google Cloud Project

1. Access the Google Cloud Console
2. Create a project (if you don’t have one)
3. Note your project ID for later use

​

Step 2: Enable Required APIs

1. Navigate to APIs & Services > Library in the Cloud Console
2. Search for and enable the following APIs required for Google Drive sync:
   • Google Drive API (required for Drive file access)
   • Google Docs API (required for Google Docs files)
   • Google Sheets API (required for Google Sheets files)
   • Google Slides API (required for Google Slides files)

​

Step 3: Configure OAuth Consent Screen

1. Navigate to APIs & Services > OAuth consent screen in the Cloud Console
2. Configure the OAuth consent screen with your application details
3. Add the required scopes (see Step 5)

​

Step 4: Create OAuth Client ID

1. Navigate to APIs & Services > Credentials in the Cloud Console
2. Click Create Credentials and select OAuth client ID
3. Select Web application as the application type
4. Set the Authorized redirect URI to:
   Copy

   http://your-frontend-dns/connectors/oauth/callback/Drive
   
   or for HTTPS:
   Copy

   https://your-frontend-dns/connectors/oauth/callback/Drive
   
5. Click Create and note your Client ID and Client Secret

​

Step 5: Configure OAuth Scopes

1. In the OAuth consent screen, navigate to the Scopes section
2. Add the following OAuth scopes required for Google Drive sync:
   • https://www.googleapis.com/auth/drive.readonly - Read-only access to Drive files
   • https://www.googleapis.com/auth/drive.metadata.readonly - Read-only access to Drive file metadata
   • https://www.googleapis.com/auth/drive.metadata - Access to Drive file metadata
   • https://www.googleapis.com/auth/documents.readonly - Read Google Docs files
   • https://www.googleapis.com/auth/spreadsheets.readonly - Read Google Sheets files
   • https://www.googleapis.com/auth/presentations.readonly - Read Google Slides files
   • https://www.googleapis.com/auth/drive.file - Access to files created by the app
   • https://www.googleapis.com/auth/drive - Full access to Drive files

​

Configuring and enabling connector

1. Navigate to the Connectors page in your account settings:
   • Go to Account > Individual Settings > Settings > Connectors

2. Click on “Add New Connectors” or “Browse Available Connectors” view available connectors

3. Find and click on the Google Drive connector card to create a new connector instance
4. In the configuration dialog that opens:
   • Enter an Instance Name for your connector (e.g., “My Drive”)
   • Enter the Google Client ID from your Google Cloud Console
   • Enter the Google Client Secret from your Google Cloud Console
   • Click on Save button to save the configuration
     
5. After saving, you will be redirected to the connector instance page. To enable the connector:

• Click on the Authenticate button (or use the Sync toggle switch)
• You will be redirected to Google’s consent screen where you need to sign in and grant permission for Google Drive and related document access

6. After giving consent, it will redirect to the frontend and if the Google Drive shows enabled, then your connector is successfully configured and enabled.