# Google Workspace Integration

Cloud Voice can connect to Google Workspace (formerly G Suite) so that your company directory does double duty as your phone system directory. Once linked, user accounts flow one way from Google Workspace into Cloud Voice, extensions can be provisioned automatically, and your team can sign in to the Cloud Voice App with the Google credentials they already use.

Here, "the PBX" (private branch exchange) means the Cloud Voice phone system itself.

## Requirements

Before you set up the integration, confirm that both sides meet the following:

| Platform | Requirement |
| --- | --- |
| Google Workspace | Business or Enterprise edition |
| Cloud Voice | Firmware [84.19.0.22](/pbx/integrations/google-workspace/firmware-dependency-reference/) or later, on the Enterprise Plan or Ultimate Plan |

:::caution
Both requirements are hard prerequisites. On firmware older than 84.19.0.22, the Google Workspace options may be missing or incomplete, and later firmware versions add more capabilities. If your system is behind, update the firmware and confirm the plan before you start. See the [firmware dependency reference](/pbx/integrations/google-workspace/firmware-dependency-reference/) for which features each version unlocks.
:::

## What the integration does

Linking the two platforms unlocks three capabilities:

- **User synchronization**: Accounts sync in one direction, from Google Workspace to Cloud Voice. When you update a user's details in Google Workspace, the change carries over automatically, so you manage the directory in one place instead of maintaining it twice. This reduces manual setup and keeps the two systems in step.
- **Automatic extension provisioning**: As users sync across, Cloud Voice can create an extension for each one and assign it, giving them immediate access to the platform's unified communications tools.
- **Single sign-on (SSO)**: Synced users log in to the Cloud Voice App with their Google credentials, so there is no separate phone-system password to distribute or remember.

:::caution
Synchronization is one-way only: Google Workspace is the source of truth. If you edit a synced user's details directly in Cloud Voice, the next sync from Google Workspace can overwrite your change. Make user changes in Google Workspace, or [pause synchronization](/pbx/integrations/google-workspace/pause-google-workspace-integration/) first if you need local edits to hold.
:::

## How the connection works

Cloud Voice authenticates to Google using the OAuth (Open Authorization) 2.0 protocol. This lets the PBX read the user data in your organization through Google's API (application programming interface) with delegated, revocable access instead of stored account passwords.

:::note
Because access is delegated through OAuth, no Google account password is ever stored on Cloud Voice, and you can revoke the connection from the Google side at any time without changing anyone's password.
:::

## Setting up and managing the integration

### Initial setup

Getting connected takes only a few steps, split between the Google side and the Cloud Voice side.

1. On the Google side, create the resources and credentials the integration relies on:
   - Create a Google Cloud project to keep the integration in its own isolated environment.
   - Enable the Admin SDK (Software Development Kit) API so the project can reach your organization's user data through the API.
   - Configure the OAuth consent screen with the branding shown to users during authorization.
   - Register a web application and generate the access credentials that let Cloud Voice read your organization's user data.
2. On the Cloud Voice side, enter the access credentials you generated.

:::tip
Keep the Google Cloud console open in one tab and Cloud Voice in another. You will copy the credentials (a client ID and client secret) straight from Google into Cloud Voice, so working side by side avoids retyping them.
:::

For the full walkthrough, see [Integrate Cloud Voice with Google Workspace](/pbx/integrations/google-workspace/integrate-cloud-voice-with-google-workspace/).

### After you connect

With the link in place, a little more configuration turns synced Google accounts into working users on the phone system:

- [Synchronize users from Google Workspace to Cloud Voice](/pbx/integrations/google-workspace/synchronize-users-from-google-workspace-to-cloud-voice/) and assign them extensions.
- [Allow users to log in to the Cloud Voice App with Google SSO](/pbx/integrations/google-workspace/allow-users-to-log-in-to-cloud-voice-app-uc-clients-with-google-sso/).

### Ongoing management

Once the integration is running, use these topics to keep it tuned to your needs:

- [Schedule automatic user synchronization](/pbx/integrations/google-workspace/schedule-automatic-user-synchronization/): set the time each daily sync runs.
- [Manually perform user synchronization](/pbx/integrations/google-workspace/manually-perform-user-synchronization/): run a sync right away to apply a new rule or push recent Google Workspace changes without waiting for the schedule.
- [Update the client secret for the integration](/pbx/integrations/google-workspace/update-client-secret-for-google-workspace-integration/): replace the secret Cloud Voice uses to authenticate, for example after rotating it in Google.
- [Pause Google Workspace synchronization](/pbx/integrations/google-workspace/pause-google-workspace-integration/): temporarily hold syncing so Google Workspace updates do not overwrite synced user data.
- [Disable the Google Workspace integration](/pbx/integrations/google-workspace/disable-google-workspace-integration/): switch the integration off for troubleshooting without losing your existing configuration.
- [Disconnect the Google Workspace integration](/pbx/integrations/google-workspace/disconnect-google-workspace-integration/): fully remove the current connection.

:::note
By default, Cloud Voice runs an automatic user synchronization at 00:30 every day. You can change this time when you [schedule automatic user synchronization](/pbx/integrations/google-workspace/schedule-automatic-user-synchronization/).
:::

:::caution
Disconnecting removes the current integration, and you must disconnect before you can connect Cloud Voice to a different directory. If you only need a short break (for example, during troubleshooting), disable or pause the integration instead, since both keep your existing configuration intact.
:::
