Skip to main content

Google Workspace App

This integration uses the Orbb Marketplace app to provide read-only access to your Google Workspace environment. Unlike the service account approach, installing a Marketplace app requires no domain-wide delegation configuration—simply install from the Google Workspace Marketplace and authorize the requested permissions. The app enables Orbb to access email metadata and calendar events across your organization, helping you track and analyze business relationships.

Prerequisites

  • A Google Workspace domain.
  • Administrative privileges to install Marketplace apps.
caution

Only users with administrative privileges can install apps for the organization. Ensure you have the necessary permissions before proceeding.

OAuth Scopes

https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/userinfo.profile
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/gmail.metadata
https://www.googleapis.com/auth/appsmarketplace.license
OAuth Scopes Explanation

The following OAuth scopes are used by the Orbb app:

  • userinfo.email / userinfo.profile: Basic user identity information for authentication.
  • admin.directory.user.readonly: Read-only access to user directory information in Google Workspace.
  • calendar.readonly: Read-only access to calendar events.
  • gmail.metadata: Access to email metadata (subject, sender, recipients, date) without reading message content.
  • appsmarketplace.license: Required for Marketplace license validation.

These scopes ensure that the application can only read data without the capability to modify it, maintaining data integrity and security.

Installation Guide

1. Navigate to the Marketplace App

The Orbb app is currently unpublished in the Google Workspace Marketplace. Please contact your Orbb representative to request access.

2. Install for Your Organization

  • Click Admin Install to begin the installation process.
  • Sign in with your Google Workspace administrator account if prompted.

3. Select Users

Choose which users will have access to the app:

  • Everyone at your organization: Install the app for all users in your domain.
  • Certain groups or organizational units: Select specific organizational units (OUs) or groups to limit which users' data the app can access.
tip

To limit access to specific inboxes, first organize the target users into an organizational unit or access group in your Google Admin console. Then select that OU or group during installation.

4. Review and Authorize

  • Review the requested permissions (OAuth scopes listed above).
  • Click Authorize to grant the app access to the selected users' data.
  • Click Finish to complete the installation.

Limiting Access to Specific Users

The Marketplace app installation allows granular control over which users' data can be accessed:

  1. Using Organizational Units (OUs)

    • Navigate to Google Admin Console > Directory > Organizational units.
    • Create or select an OU containing the users whose data should be accessible.
    • When installing or managing the app, select this OU instead of the entire organization.
  2. Using Access Groups

    • Create a group in Directory > Groups containing the target users.
    • Select this group during app installation to limit data access to group members only.
  3. Managing Access After Installation

    • Go to Apps > Google Workspace Marketplace apps > Apps list.
    • Click on the Orbb app to modify which OUs or groups have access.
info

For more details on managing app access, see Install Marketplace apps for your organization.

App vs Service Account

FeatureMarketplace AppService Account
Setup complexitySimple one-click installRequires domain-wide delegation configuration
User access controlBuilt-in OU/group selectionAll users in the domain

For the service account approach, see the Google Workspace documentation.