How to create and configure a project in Google Cloud Platform to manage Google Workspace in Cayosoft Administrator

Summary: This article contains step-by-step instructions on how to create and configure a project in Google Cloud Platform to manage Google Workspace in Cayosoft Administrator.

Applies to: Cayosoft Administrator 9.1.0 or later

ID: KB20220211-1

Content: 

Required prerequisites

1. Install PSGSuite PowerShell module from PowerShell Gallery: https://www.powershellgallery.com/packages/PSGSuite/

Create a new project in Google Cloud Platform

1. Sign in to https://console.developers.google.com using a Google account.
2. Click Create Project.
3. Specify project name.
4. Click Create.

Enable the APIs

1. 1. In the Navigation menu in Google Cloud Platform select APIs & Services > Library.
   2. In the API Library search one by one for the following APIs and enable them:
      
      1. Admin SDK
      2. Contacts API
      3. Drive Activity API (Apps Activity API v2)
      4. Enterprise License Manager API
      5. Gmail API
      6. Google Calendar API
      7. Google Classroom API
      8. Google Docs API
      9. Google Drive API
      10. Google Sheets API
      11. Google Slides API
      12. Groups Settings API
      13. Hangouts Chat API
      14. People API

Create Service Account

1. In the Navigation menu in Google Cloud Platform select IAM & Admin > Service Accounts.
2. Click Create Service Account.
3. Specify the Service Account name. 
4. Service Account ID will be generated automatically.
5. Click Create and Continue.
6. In the Grant this service account access to this project select Owner role.
7. Click Done.
8. On the created Service Account click the Details tab - save Email and Unique ID in a Notepad, you will need them when you fill out the Google Workspace extension in the Cayosoft Administrator Console.

Create the key for the Service Account

1. Select the created Service Account and in the Actions menu click Manage Keys. 
2. Click Add Kye > Create a new key.
3. Select P12 key type.
4. Click Create - the key file will be generated and downloaded automatically.
   Note: Store the key file and private key password securely. You will need the key file, service account Unique ID, and Email when configuring the Google Workspace extension in the Cayosoft Administrator console.
5. Click Close.

Check that APIs are enabled

1. In the Navigation menu in Google Cloud Platform select APIs & Services > Enabled APIs & services.
2. Scroll down to the list of APIs and check that the following APIs are added to the list:
   1. Admin SDK
   2. Contacts API
   3. Drive Activity API (Apps Activity API v2)
   4. Enterprise License Manager API
   5. Gmail API
   6. Google Calendar API
   7. Google Classroom API
   8. Google Docs API
   9. Google Drive API
   10. Google Sheets API
   11. Google Slides API
   12. Groups Settings API
   13. Hangouts Chat API
   14. People API

Add API Client Access in Google Admin Console

1. Sign in to https://admin.google.com/ using a Google Admin account.
2. In Navigation menu select Secutiry > Access and data control > API Controls.
3. Scroll down to Domain Wide Delegation and click Manage Domain Wide Delegation.
4. Click Add new.
5. On Add a new client ID form specify Unique ID of created Service Account.
6. In OAuth Scopes specify the list of allowed APIs - copy\paste this APIS list:
   https://apps-apis.google.com/a/feeds/emailsettings/2.0/,
   https://mail.google.com/,
   https://sites.google.com/feeds,
   https://www.google.com/m8/feeds/contacts,
   https://www.googleapis.com/auth/activity,
   https://www.googleapis.com/auth/admin.datatransfer,
   https://www.googleapis.com/auth/admin.directory.customer,
   https://www.googleapis.com/auth/admin.directory.device.chromeos,
   https://www.googleapis.com/auth/admin.directory.device.mobile,
   https://www.googleapis.com/auth/admin.directory.domain,
   https://www.googleapis.com/auth/admin.directory.group,
   https://www.googleapis.com/auth/admin.directory.orgunit,
   https://www.googleapis.com/auth/admin.directory.resource.calendar,
   https://www.googleapis.com/auth/admin.directory.rolemanagement,
   https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly,
   https://www.googleapis.com/auth/admin.directory.user,
   https://www.googleapis.com/auth/admin.directory.user.readonly,
   https://www.googleapis.com/auth/admin.directory.user.security,
   https://www.googleapis.com/auth/admin.directory.userschema,
   https://www.googleapis.com/auth/admin.reports.audit.readonly,
   https://www.googleapis.com/auth/admin.reports.usage.readonly,
   https://www.googleapis.com/auth/apps.groups.settings,
   https://www.googleapis.com/auth/apps.licensing,
   https://www.googleapis.com/auth/calendar,
   https://www.googleapis.com/auth/chat.bot,
   https://www.googleapis.com/auth/classroom.announcements,
   https://www.googleapis.com/auth/classroom.courses,
   https://www.googleapis.com/auth/classroom.coursework.me,
   https://www.googleapis.com/auth/classroom.coursework.students,
   https://www.googleapis.com/auth/classroom.guardianlinks.students,
   https://www.googleapis.com/auth/classroom.profile.emails,
   https://www.googleapis.com/auth/classroom.profile.photos,
   https://www.googleapis.com/auth/classroom.push-notifications,
   https://www.googleapis.com/auth/classroom.rosters,
   https://www.googleapis.com/auth/classroom.rosters.readonly,
   https://www.googleapis.com/auth/drive,
   https://www.googleapis.com/auth/gmail.settings.basic,
   https://www.googleapis.com/auth/gmail.settings.sharing,
   https://www.googleapis.com/auth/plus.login,
   https://www.googleapis.com/auth/plus.me,
   https://www.googleapis.com/auth/tasks,
   https://www.googleapis.com/auth/tasks.readonly,
   https://www.googleapis.com/auth/userinfo.email,
   https://www.googleapis.com/auth/userinfo.profile
7. Click Authorize.

Configure Google Workspace extension in Cayosoft Administrator Console

1. In Admin Console navigate to Home > Configuration > Connected Systems Extensions > Google Workspace (Beta).
2. Configure the extension as it is described in the Google Workspace (Beta) extension settings – Cayosoft Help Center.
3. Click Check Settings to validate the specified settings and verify that the specified credentials are correct.

List of automation rules and web actions for Google Workspace management 

1. New User web action (Google)
2. Properties web action (Google user)
3. Delete web action (Google user)
4. Text file | Create Google Users rule
5. Text file | DynamicAttributes Update Google Users Properties rule