Skip to main content
 

Tip

This article was accurate at the time of writing, but changes happen. If you find the instructions are outdated, leave a description in the comment field below and let us know!

This document provides prerequisites and Expel Workbench on-boarding steps for Google Workspace.

Items to be produced

Description

Admin Username

The admin username used to generate the service account. Only Admin accounts can access the Admin SDK reports API, so we need to impersonate the admin user through our service account.

Service Credentials JSON File

The credential file generated for the service account.

API Scopes

The permissions granted to the service account. This must be exactly what was provisioned in Google Workspace.

Step 1: Provision Expel Service Account in Google Workspace

  1. Go to the Google Developers Console and sign in as a super administrator.

  2. Under IAM & Admin, click Manage Resources.

  3. Click Create Project.

    image-1
  4. Type project details and click Create.

    For this field

    Type this

    Project name

    Can be anything you want but we recommend "ExpelAPI".

    Organization

    The name of your organization.

    Location

    Typically the name of your organization. You can put it wherever makes the most sense, however.

  5. Each project uses its own set of APIs. For Expel to communicate with Google Workspace APIs, we need to enable the Admin SDK for the newly created project. Navigate to the newly created project.

  6. Search for Admin SDK and open.

    image-3
  7. Enable the Admin SDK for the new project.

    image-4
  8. Create a Service Account for Expel Access. Navigate to Menu > IAM & admin > Service accounts.

    image-5
  9. Click Create Service Account.

    image-6
  10. Fill in the service account details.

    For this field

    Type this

    Service account name

    Can be anything but we recommend "ExpelAPI".

    Service account ID

    Can be anything but we recommend "ExpelAPI".

    Service account description

    Can be anything but we recommend "ExpelAPI".

  11. image-7
  12. In the IAM & Admin section, click Service Accounts. For the service account that relates to this integration, click the Actions button and then Manage keys. In the Add Key section, click Create new key. Select JSON and click Create. After you click Create, a JSON file is downloaded.

    Tip

    Keep this file in a safe place! It contains the credentials for this service account.

    image-8
    image-9
  13. Enable domain-wide delegation for the service account.

    • Back on the Service Accounts screen, click Actions and then click Manage Details.

    • Select Enable Google Workspace Domain-wide Delegation under Details section.

      image-10
      image-11
  14. After the service account is created, in the Details area, copy Unique ID.

  15. Grant the service account the required API permission scope.

    • Open the Google Workspace admin console https://admin.google.com/ac/owl/domainwidedelegation

    • Navigate to Security > API Controls > Manage Domain Wide Delegation.

    • Click Add New.

      • Client Name: The Client ID that we saved from our Service Account, in the earlier step.

      • API Scopes: You can copy and paste all, which are comma-delimited or add the scopes individually.

        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.reports.audit.readonly, https://www.googleapis.com/auth/admin.reports.usage.readonly

        Scope for only retrieving organizational units:

        image-13

Step 2: Configure Google Workspace in Workbench

  1. In a new browser tab, login to https://workbench.expel.io.

  2. On the console page, navigate to Settings and click Security Devices.

  3. At the top right of the page, click Add Security Device.

    image-14
  4. Search for and select Google Workspace.

    mceclip0.png
  5. Fill in the following information.

    • Select Expel Cloud Service for SIEM.

    • Type device Name and Location.

    • For Admin username, type the email address of the Super Administrator that created the service account in Step 1.

    • For Service Credentials JSON, type the contents of the JSON file for the service account, generated in Step 1.

    • For API scopes, type the API Scopes from Step 1.

GSuite, G Suite