Using Google Calendar / Google Workspace

Warning

Prerequisites for Google Calendar Integration:

Before connecting Google Workspace, configure a valid public domain name and a valid SSL certificate issued by a trusted certificate authority on SOPS.

Go to https://<SOPS-LAN-IP>/settings/security to configure the domain and enable HTTPS. The public endpoint must be reachable by Google for calendar notifications.

Summary

To integrate Google Calendar or Google Workspace with SyncSign On-Premise Server (SOPS):

  1. Create or select a Google Cloud project.

  2. Enable the Google Calendar API and Google People API.

  3. Configure the Google Auth Platform branding, audience, and data access.

  4. Create a Web application OAuth client with the SOPS redirect URI.

  5. Enter the credentials, authorize an account, and bind calendars in the SOPS Portal.

Use Google’s official instructions for the current Google Cloud interface:

Create a Google Cloud Project and Enable APIs

  1. Open the Google Cloud Console project selector and create a project or select an existing project owned by your organization.

  2. Open the Google Cloud API Library.

  3. Enable Google Calendar API.

  4. Enable Google People API.

Configure Google Auth Platform

  1. In Google Auth Platform, configure Branding with an application name, user support email, developer contact information, and the SOPS authorized domain.

  2. Configure Audience:

    • Select Internal when only users in your Google Workspace organization will authorize SOPS.

    • Select External when other Google accounts must authorize SOPS. While the application is in Testing, add every account that will test the integration as a test user.

  3. Under Data Access, add the Google Calendar and Google People scopes required by SOPS. Request only the scopes needed for your deployment.

Note

Google may require verification for an External production application that requests sensitive scopes. Internal Google Workspace applications normally do not require public app verification.

Create OAuth Credentials

  1. Open Clients in Google Auth Platform and create an OAuth client.

  2. Select Web application as the application type.

  3. Under Authorized redirect URIs, enter exactly:

    https://<Your-SOPS-Domain>/gsuite-gcal/oauth/callback

    The scheme, domain, port, path, and trailing slash must match exactly. Otherwise, Google returns a redirect_uri_mismatch error.

  4. Create the client and securely record its Client ID and Client Secret.

Connect Google Workspace to SOPS

  1. Open the SOPS Portal at https://<Your-SOPS-Domain>.

  2. Go to Settings > Integration > Google Workspace and select Edit.

  3. Enter the Client ID and Client Secret, then select Save.

  4. Select Connect or Authorize and sign in with the Google account that has access to the required calendars or room resources.

  5. Complete the Google consent flow and confirm that the integration is shown as connected.

  6. Open Nodes in the SOPS Portal and select the Display to configure.

  7. Select Google Workspace as its calendar data source, choose the required calendar or room resource, and save the Display configuration.

  8. Use Refresh on the Nodes page to fetch the latest calendar data and update the Display.

Note

Domain verification is required for webhook notifications that provide real-time calendar updates.