〽️Google Workspace

Add Google Workspace

To integrate Google WS into Regulait, on the Available Integrations page, click on the Google WS icon (marked with an arrow below).

the GitHub icon is marked with an arrow

In the "Add Integration" window below, we must provide the "Service Account Config" JSON file.

We also need to ensure that our Google WS Project has all required API Keys.

These Keys are crucial for the Regulait system to gather information from the Integration App.

Regulait only requires Read-Only access, as it retrieves data solely for compliance purposes, without making any changes, deletions, or additions to the Google WS system.

the Add Integration window

The Google WS System

Open the Google WS cloud platform, or use this link: console.cloud.google.com

On the platform, click on the 'Select a Project' button (marked with an arrow below).

the 'Select a Project' button is marked with an arrow

Create a New Project

Now click on New Project (marked with an arrow below).

the New Project button is marked with an arrow

Name the new project and click on 'Create'.

the Create New Project page

Add API Keys

Now, on the left sidebar, navigate to the API & Services tab (marked with an arrow below).

the API & Services tab is marked with an arrow

Click the 'Enable APIs and Services' button (marked with an arrow below).

the 'Enable APIs and Services' button is marked with an arrow

Using the search bar, search for and add the following API keys:

  • Admin SDK

  • Gmail API

  • Google Calendar API

  • Tasks API

  • Contacts API

the API Library search bar

On each API key's page, select 'Enable' (marked with an arrow below).

'Enable' is marked with an arrow

Back on the APIs page, make sure you've enabled all five required API keys (circled below).

all five required API keys are circled

Create a Service Account

On this page, select the 'Credentials' tab (marked with an arrow below).

the 'Credentials' tab is marked with an arrow

Now click on 'Create Credentials' (marked with an arrow below).

'Create Credentials' is marked with an arrow

Select 'Service Account' (marked with an arrow below).

'Service Account' is marked with an arrow

Name the account and give it a description.

naming a new service account

Create a JSON Key

After the service account is created, on the Keys tab, click on the 'Add Key' button (marked with an arrow below).

the 'Add Key' button is marked with an arrow

Select the 'Add New Key' button.

adding a new Key

Make sure that the Key Type selected is JSON, and click on 'Create'.

selecting the JSON Key Type

At the bottom of the Service account's page, copy the Client ID number (marked with an arrow below).

copying the Client ID number

Domain Wide Delegation

Now open the Admin management site: admin.google.com

On the site's left sidebar, navigate to Security - Access and Data Control - API Controls (marked with an arrow below).

navigating to the API Controls site

On this page, click on the 'Manage Domain Wide Delegation' button (marked with an arrow below).

the 'Manage Domain Wide Delegation' button is marked with an arrow

Now select 'Add New' (marked with an arrow below).

adding a new API Client

Enter the copied Client ID in the Client ID field.

In the OAuth Scopes field, enter (copy and paste) the following API Permission:

https://www.google.com/m8/feeds,https://www.googleapis.com/auth/analytics,https://www.googleapis.com/auth/calendar,https://www.googleapis.com/auth/calendar.readonly,https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/gmail.modify,https://www.googleapis.com/auth/tasks,https://www.googleapis.com/auth/tasks.readonly

Then click on 'Authorize'.

pasting necessary field inputs

Adding the Integration

Back in the Regulait Add Integration window, upload the JSON file that was automatically downloaded while creating the API Key.

naming the integration and Uploading the JSON API Key file

Vendor Management for an Integration

Now select the proper Vendor that provides the Google WS service.

To learn more about Vendor Management - click here.

If we don't have an appropriate Vendor, we can also create a Vendor here on the Add Integration window, and click on the Create Vendor button (marked with an arrow below).

the 'Create Vendor' button is marked with an arrow

After filling out all Mandatory fields, click on the Add Integration button (marked with an arrow below).

the 'Add Integration' button is marked with an arrow

On the Installed Integration page, we can view our Installed Integrations, in the Image below, we can see one Google WS Integration installed.

To learn more about using and managing Integrations, continue to the Using Integrations guide chapter.

viewing a newly installed integration

To return to the Integrations Guide hub, click here.

To return to the main guide hub, click here.

Last updated