Comment on page

Google Workspace Integration

11/2023

Overview

Oort can analyze data from Google Workspace (formerly G Suite) to provide insights into user identities and application activity in that platform.
This document will walk you through the process of setting up API access from Google Workspace and Google Cloud Platform (GCP) to Oort.

Next Steps

Once the integration is complete and the Oort platform has completed the analysis of the data, Oort will set up a review with you and your team to share insights discovered through the integration.

Google Workspace Integration

Google Workspace has two APIs in use for this integration -
  • Directory API - Manage your organization’s users, connected devices, and third-party applications.
  • Reports API - Generate reports about customers and user usage.

Understanding Oort Read and Write API Permissions

There are two groups of API permissions or OAuth scopes that can be used with your Oort tenant and Google Workspace -
  • Read-only - used for data ingestion and analysis only
  • Read/write (which includes the first set of read-only scopes) - read/write permissions are used for the defined list of Oort Remediation Actions.
Remediation actions can only be taken by administrator or help desk roles in Oort and are limited to the list in the above article.

High-level Setup Steps

There are 3 separate sets of configurations required to connect Oort to your Google Workspace environment.
  1. 1.
    Google Cloud (GCP) configuration
  2. 2.
    Google Workspace configuration
  3. 3.
    Oort integration setup and testing

Google Cloud (GCP) - Detailed Configuration Steps

  1. 1.
    Login to the GCP console for your organization.
  2. 2.
    NOTE - the GCP admin account you use for these steps must have permissions to the Project you want to use (see steps 3-6 below) AND it must have the iam.serviceAccountKeys.create permission.
  3. 3.
    GCP Project - The steps below must occur within a specific GCP project. It doesn't make a difference in which project the Oort integration service account and Admin API SDK are enabled, as long as the steps below in this section can be completed. If you prefer for the Admin API SDK to be enabled in it's own project, then create a new, specific project in GCP for this integration. Otherwise, simply select an existing project.
  4. 4.
    If the Google Admin API SDK is not enabled for your tenant, please enable it. For information, see this Google Cloud article. This is found under Google Cloud -> APIs and Services -> Enable APIs and Services
  5. 5.
    Type in Admin API SDK in the search bar and click the corresponding SDK box
  6. 6.
    Click Enable
  7. 7.
    Create a Service account in the Google Cloud Platform (GCP) for the purposes of the integration.
  8. 8.
    Provide a name and description for the account
  9. 9.
    From the Service Account that was created in GCP, create keys, which are downloaded as a JSON file when created. Save this JSON file, as it will be added to the Oort integration instance
  10. 10.
    Note the Unique ID / Oauth2 client ID for use in the next section when you delegate domain authority for the Workspace API

Google Workspace - Detailed Config Steps

  1. 1.
    In Google Workspace (admin.google.com), create a new account or choose an existing administrator account for the Service account to impersonate. Note - if you elect to use an existing account in Workspace, you will need to be able to give it the role you create below.
  2. 2.
    Create a custom role via the following steps:
    1. 1.
      Navigate to Account > Admin roles > Create new role
    2. 2.
      Provide a suitable name and description
    3. 3.
      Under Admin console privileges check the following privileges
      Organizational Units > Read
      Users > Read
      Services > Mobile Device Management > Manage Devices and Settings
      Services > Chrome Management > Settings > Manage Chrome OS Devices > Read
      Security > User Security Management
      Security > Reports
    4. 4.
      Under Admin API privileges check the following privileges
      Organizational Units > Read
      Users > Read
      Groups > Read
      User Security Management
  3. 3.
    When finished, the role should look like this -
    Click Create Role to finish.
  4. 4.
    Assign this role to the account that was created in Workspace or the existing account.
  5. 5.
    Delegate domain-wide authority to the Google Cloud service account created in the GCP section above, as explained in https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority
  6. 6.
    Click Add New
  7. 7.
    In the OAuth scopes (comma-delimited) field,
    1. 1.
      Add the Oauth2 Client ID for the GCP service account created in the section above, which is tied to the JSON keys downloaded.
    2. 2.
      Add the following scopes using this code block below. Click Authorize.
https://www.googleapis.com/auth/admin.directory.group.member.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly,https://www.googleapis.com/auth/admin.directory.orgunit.readonly,https://www.googleapis.com/auth/admin.directory.device.mobile.readonly,https://www.googleapis.com/auth/admin.reports.audit.readonly,https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly,https://www.googleapis.com/auth/admin.directory.user.security
  1. 8.
    Hit View Details for the API client created and confirm it looks as shown:
Here is the list for reference:

Oort Integration - Detailed Configuration Steps

  1. 1.
    From the Integrations page, click Add Integration and select Google Workspace.
  2. 2.
    Enter a name for the integration, such as Google-customername.
  3. 3.
    Enter your unique Google Workspace or Cloud customer ID. Note - You can find this ID in your Admin console: Account > Account settings > Profile.
  4. 4.
    Enter the user principal name of the Google Workspace administrator account that the service account is impersonating.
  5. 5.
    Upload the JSON key file created for the service account in the step 9 of the Google Cloud (GCP) - Detailed Configuration Steps section above.
  6. 6.
    Click Save.

Test the Configuration

To test the configuration and start the initial data collection -
  1. 1.
    Click the 3 dots at the right of the new Google integration and select Test Connectivity.
  2. 2.
    Once successful, click the 3 dot menu again and select Collect Now. Collection may take some time, depending on the size of the Google environment.

Updating Google Service Account Keys

If desired, the JSON keys created for the service account can be rotated or updated.
  1. 1.
    Simply create new keys for that service account in the Google Cloud console and save as a JSON file.
  2. 2.
    In the Oort console, click the 3 dot menu for the Google integration and select Edit Settings.
  3. 3.
    Select Reset Credentials. Then upload the new JSON file and click Save.
  4. 4.
    Test connectivity to ensure a successful connection.