Google Workspace

Documentation Index

Fetch the complete documentation index at: https://docs.getomni.co/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

What Gets Indexed

​

How It Works

1. A service account with domain-wide delegation accesses Google Workspace APIs
2. The connector syncs content based on user permissions
3. Permission inheritance ensures users only see content they have access to in Google Workspace

​

Prerequisites

• Google Cloud Platform account with billing enabled
• Google Workspace admin access (Super Admin or delegated admin)
• Google Cloud CLI (gcloud) installed and authenticated (optional, for enabling APIs via CLI)

​

Setup

​

Step 1: Create a Google Cloud Project

1. Go to the Google Cloud Console
2. Click Select a project → New Project
3. Enter project name: omni-workspace-integration
4. Select your organization
5. Click Create

​

Step 2: Enable Required APIs

gcloud services enable admin.googleapis.com
gcloud services enable drive.googleapis.com
gcloud services enable gmail.googleapis.com
gcloud services enable docs.googleapis.com
gcloud services enable sheets.googleapis.com
gcloud services enable slides.googleapis.com

​

Step 3: Create Service Account

1. Go to IAM & Admin → Service Accounts
2. Click Create Service Account
3. Name: omni-workspace-connector
4. Description: Service account for Omni Google Workspace integration
5. Click Create and Continue
6. Skip the optional steps and click Done

​

Step 4: Get the Client ID

1. Click on the newly created service account
2. Go to the Details tab
3. Under Advanced settings, copy the Client ID (also shown as the service account’s Unique ID) — you’ll need this in Step 6 to authorize domain-wide delegation

​

Step 5: Create Service Account Key

1. Go to the Keys tab
2. Click Add Key → Create new key
3. Select JSON format
4. Click Create
5. Save the downloaded key file securely

​

Step 6: Configure Domain-Wide Delegation in Admin Console

1. Open the Google Workspace Admin Console
2. Navigate to Security → Access and data control → API controls
3. Click Manage Domain Wide Delegation
4. Click Add new
5. Enter the Client ID from Step 4
6. Add the following OAuth scopes:

https://www.googleapis.com/auth/admin.directory.user.readonly,
https://www.googleapis.com/auth/admin.directory.group.readonly,
https://www.googleapis.com/auth/drive.readonly,
https://www.googleapis.com/auth/gmail.readonly,
https://www.googleapis.com/auth/documents.readonly,
https://www.googleapis.com/auth/spreadsheets.readonly,
https://www.googleapis.com/auth/presentations.readonly

7. Click Authorize

​

Step 7: Configure Omni

1. Navigate to Settings → Integrations in Omni
2. Find Google Workspace and click Connect
3. Paste the contents of the service account key file from Step 5
4. Enter your Google Workspace domain
5. Enter the admin email address
6. Click Connect, and click Configure against either the Drive or Gmail source
7. Choose which sources you want enabled, select any specific users to include/exclude, and click Save Configuration
8. Wait for the initial sync to complete

​

Managing the Integration

​

Viewing Sync Status

​

Rotating Service Account Keys

1. Create a new key in Google Cloud Console
2. Update the key in Omni settings
3. Delete the old key

​

Removing the Integration

1. Navigate to Settings → Integrations
2. Click Configure against the Google Workspace source
3. Click Delete Permanently
4. Optionally, delete the service account in Google Cloud and remove the domain-wide delegation entry in Admin Console

​

Troubleshooting

gcloud services list --enabled --project=YOUR_PROJECT_ID

​

Security Considerations

• Read-only access: The service account only has read permissions
• Permission inheritance: Users only see content they can access in Google Workspace
• Key security: Service account keys should be treated like passwords
• Audit logging: Enable Cloud Audit Logs to monitor API access
• Key rotation: Rotate service account keys every 90 days

​

What’s Next