Google Workspace Integration
This document provides a step-by-step guide for integrating Google Workspace with TheStorage service. These steps are essential for the service to retrieve and synchronize "Domain" user data. The service exclusively fetches profile data. To streamline the user experience and reduce the necessity for individual user configuration and setup, you must create a Google Workspace Service Account. This account enables seamless background actions on behalf of your users.
Requirements
Google Workspace Admin permissions are required to complete the following steps.
Steps
Navigate to console.cloud.google.com.
Create a New Project.
Name the project as TheStorage. If required by your organization, you can choose a specific location, although it's recommended to place it in the top-level location.
Click the Create button. It may take a few moments to create the new project.
Within the APIs & Services menu, choose Credentials.
Click the Create Credentials button and choose the Service Account menu item.
On the Create Service Account page, enter the following information:
Service Account Name: thestorage_svc
Service Account ID: thestorage_svc (automatically generated)
Service Account Description (optional): TheStorage Service Account
When you're ready, click the CREATE AND CONTINUE button.
There's no need to grant access to the project. Click on the CONTINUE button.
You don't have to provide user access to this service account. Click on the DONE button.
Now, you have a service account. However, there are still some additional steps to complete.
Click the edit (pencil) button for the service account.
On this page, you'll find a unique ID. Please make sure to copy this number and store it somewhere. You'll need it shortly.
On this page, click on the KEYS tab.
Click the ADD Key button, and choose the Create new key menu item.
Under the Key Type, choose JSON (which is the default option), and then click on the CREATE button.
You will download a JSON file that will be required later. Please ensure you keep this file in a secure location.
Now that the Service Account is set up, let's proceed to grant it some permissions.
Now that the service account is ready, the final step on the Google side is to grant permissions to this account.
Navigate to the https://admin.google.com page and log in using the Administrator account.
From the left sidebar menu, go to Security -> Access and Data Control -> API controls. If you don't see it, you can use the search bar to find it.
Click on the MANAGE DOMAIN WIDE DELEGATION button.
On this page, click the Add new button.
- In the Add new client ID pop-up, configure the following values:
Client ID: Paste the Unique ID here that you saved earlier.
OAuth scopes: https://www.googleapis.com/auth/admin.directory.user.readonly
Click the AUTHORIZE button.
The administrative tasks are complete. The final step is to fill out the Google Workspace integration form on TheStorage site.
- You will need the following:
- The JSON file that you downloaded during the key generation.
- The domain name that the company uses (e.g., mycompanyname.com).
- The email address of the administrator who is executing this task.