Google Workspace Integration Guide

Yeastar P-Series Software Edition supports the integration with Google Workspace (formerly G Suite), enabling one-way synchronization of user accounts from Google Workspace to the PBX, and allowing Single Sign-on (SSO) for users to log in to Linkus UC Clients using their Google credentials.

Requirements

Platform Requirement
Google Workspace
  • Edition: Business or Enterprise edition
Yeastar PBX
  • Firmware: Version 83.19.0.22 or later
  • Plan: Enterprise Plan or Ultimate Plan
  • Network:
    • Well configured with Yeastar FQDN or Public IP (NAT)
      Note: If you want to implement Google Single Sign-on (SSO), you MUST set up Yeastar PBX with Yeastar FQDN, Yeastar Domain, or External Host, as IP address can't be used as the SSO redirect URI due to Google restriction.
    • Accessible to Google service
      Tip: You can verify network connectivity using PBX's inbuilt IP Ping feature (Path: Maintenance > Troubleshooting > IP Ping):

Key features

The integration of Google Workspace and Yeastar P-Series Software Edition provides the following key features:

Google Workspace User Sync
Support one-way synchronization of user accounts from Google Workspace to Yeastar PBX. User information updates in Google Workspace are automatically synchronized to PBX, thus streamlining user management and reducing manual configuration.
Auto Create Extensions
Automatically create and assign extensions to the synced Google users, allowing them to explore Yeastar PBX's unified communications features through their extensions.
Single Sign-on (SSO)
Allow the synced Google users to log in to Linkus UC Clients using their Google credentials, eliminating the need to remember separate login passwords and simplifies user access.

Integration setup and management

Yeastar P-Series Software Edition integrates with Google Workspace by leveraging Google's OAuth 2.0 protocol for authenticated and authorized API access, enabling access to user data within your organization in a secure manner.

For more information about the integration's setup and management, refer to the followings:

Integration setup
The integration requires minimal configuration. You only need to complete the following configurations on Google and PBX sides:
  1. Create resources and credentials on Google side.
    • Create a Google Cloud project to isolate the integration environment.
    • Enable Admin SDK API to allow access to user data within the organization via API.
    • Configure OAuth consent to customize the branding information to be displayed when authorizing the integration.
    • Create a web application and obtain access credentials to authenticate Yeastar PBX to access user data within the organization.
  2. Fill in the obtained access credentials on PBX side.
For more information, see Integrate Yeastar P-Series Software Edition with Google Workspace.
Post-integration setup
After the integration is implemented, you should configure PBX to enable Google users to access PBX's unified communications features.
For more information, see Synchronize Users from Google Workspace to Yeastar P-Series Software Edition and Allow Users to Log in to Linkus UC Clients with Google SSO.
Integration management
Manage the integration as needed, following the topics below: