Google Workspace Integration

Overview

The Google Workspace integration connects the Virtual-Call Cloud PBX with your organization's Google Workspace (formerly G Suite) directory. Once configured, it provides one-way synchronization of users from Google Workspace to the PBX—automatically creating and assigning extensions—and allows synced users to log in to the Virtual-Call UC Client using their Google credentials via Single Sign-On (SSO).

This integration is ideal for organizations that use Google Workspace to manage their users and want to eliminate manual extension provisioning and separate password management for the phone system.

What the Integration Provides

• User Synchronization: Users from Google Workspace (individual users, users from specific organizational units, or specific groups) are synchronized to the Cloud PBX. Extensions are created and assigned automatically for synced users.
• Synchronized User Data: The following fields are synchronized from Google Workspace and can only be updated in Google (changes are reflected in the PBX at the next sync): First Name, Last Name, Email Address, Mobile Number, Job Title.
• Automatic Extension Management: When a new user is added to Google Workspace and falls within the sync scope, their PBX extension is automatically created. When a user is removed from Google Workspace, their extension can be automatically deleted.
• Single Sign-On (SSO): Synced users can log in to the Virtual-Call UC Client using their Google credentials—no separate PBX password required.

Prerequisites

• A Google Workspace account (Business or Enterprise edition)
• A Google account with Super Administrator privileges in your Google Workspace organization
• Access to Google Cloud Console to create a project and configure OAuth credentials
• Administrator access to the Virtual-Call Cloud PBX web portal

Setup Overview

The integration requires steps in both Google Cloud Console and the Cloud PBX web portal. The process uses OAuth 2.0 for secure authentication.

Part 1: Obtain Redirect URIs from the PBX

1. Log in to the Cloud PBX web portal as an administrator.
2. Go to Integrations > Google Workspace.
3. Note the redirect URI(s) displayed on the page—you will need these when configuring OAuth credentials in Google Cloud Console.

Part 2: Set Up a Google Cloud Project

1. Open the Google Cloud Console and sign in with your Google Workspace Super Administrator account.
2. Create a new project (or select an existing one).
3. In the left menu, go to APIs & Services > OAuth consent screen.
   • Select Internal as the user type (limits access to your organization only).
   • Fill in the required application information (app name, support email, etc.) and click Save and Continue.
4. Go to APIs & Services > Credentials and click Create Credentials > OAuth client ID.
   • Select Web application as the application type.
   • Under Authorized redirect URIs, add the redirect URI(s) you copied from the PBX in Part 1.
   • Click Create.
5. After creation, copy and save the Client ID and Client Secret—you will need these in the next step.

Part 3: Enable the Admin SDK API

1. In Google Cloud Console, go to APIs & Services > Library.
2. Search for Admin SDK API and click Enable. This API is required for the PBX to read user and organizational unit data from your Google Workspace directory.

Part 4: Connect the PBX to Google Workspace

1. Return to the Cloud PBX web portal > Integrations > Google Workspace.
2. Enter the following details:
   • Client ID: From the OAuth client you created in Google Cloud Console
   • Client Secret: From the OAuth client you created in Google Cloud Console
3. Click Authorize. You will be redirected to a Google login page—sign in with your Google Workspace Super Administrator account and grant the requested permissions.
4. After authorization, you will be returned to the PBX portal. The connection status should show as connected.

User Synchronization

After the connection is established, configure which users to synchronize:

1. In the Cloud PBX web portal, go to Integrations > Google Workspace > User Synchronization.
2. Choose the synchronization scope:
   • All Users: Synchronize all users in your Google Workspace organization
   • Specific Organizational Units: Only synchronize users belonging to selected Google OUs
   • Specific Groups: Only synchronize users belonging to selected Google Groups
3. Configure the Extension Assignment Rule to define how PBX extension numbers are assigned to synchronized users.
4. Click Save and then Sync Now to run the first synchronization.

Subsequent synchronizations run automatically. Changes made to users in Google Workspace are reflected in the PBX after the next sync.

Single Sign-On (SSO)

After the integration is connected, synced users can use their Google credentials to log in to the Virtual-Call UC Client:

• On the UC Client login screen, select Sign in with Google.
• The user is redirected to Google's sign-in page. After signing in with their Google credentials, they are logged in to the UC Client automatically.

No additional SSO configuration is required—SSO is enabled automatically once the Google Workspace integration is active.

Troubleshooting

• Authorization fails or is stuck on the Google consent screen.
  Ensure you are signing in with a Google Workspace Super Administrator account. Verify that the redirect URI in your Google Cloud OAuth client exactly matches the URI shown in the PBX portal (including any trailing slashes).
• Users are not synchronized after saving the configuration.
  Click Sync Now to trigger an immediate synchronization. Ensure the Admin SDK API is enabled in your Google Cloud project. Check that the authorized account has access to read user data.
• Only some users appear after synchronization.
  Verify the sync scope configuration. Users outside the selected organizational units or groups will not be included. Ensure the selected OUs or groups contain the expected users in Google Workspace.
• SSO login does not work.
  Ensure the user was successfully synchronized (visible in the PBX user list). Verify the user's Google account is active and not suspended. The Google account email must match the email on the user's PBX extension.