Integrate Yeastar P-Series Software Edition with Google Workspace

This topic describes how to integrate Yeastar P-Series Software Edition with Google Workspace.

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):

Step 1. Obtain Redirect URIs from Yeastar PBX

Obtain redirect URIs from Yeastar P-Series Software Edition, which are required for the subsequent configuration in Google Workspace.

  1. Access the configuration page of Google Workspace integration.

    1. Log in to PBX web portal, go to Integrations > Collaboration.
    2. On the right of Google SSO, click Integrate.
  2. In the App Registration section, select and note down the following redirect URIs.

    • Redirect URI: The URL to which you are redirected after the integration authentication is completed.
    • Client SSO Redirect URI: The URL via which users can sign in to Linkus UC Clients using their Google credentials.
      Important: Do NOT select the public IP, as IP address can't be used as the SSO redirect URI due to Google restriction.

Step 2. Create resources and credentials in Google Workspace

Create a Cloud project for the integration and configure the required API settings using a super admin account.

  1. Create a dedicated Cloud project under your organization.
    1. Log in to Google Cloud console, search Create a Project and select it from the search results.

    2. Set up the project, then click Create.

      • Project name: Enter a name to help you identify the project.
      • Organization: Select an organization to associate with the project.
      • Location: Select an organization to associate with the project.
  2. Enable Admin SDK API in the Cloud project to allow access to user data within the organization via API.
    1. In the search bar, search Admin SDK API and select it from the search results.

    2. Click ENABLE.

  3. Configure OAuth consent screen to customize branding information, which will be displayed when you authorize access to an application (which will be created later).
    1. In the search bar, search Branding and select it from the search results.

    2. Click Get Started.

    3. Follow the wizard to complete the settings below.

  4. Create a web application and obtain access credentials to authenticate Yeastar PBX to access user data within the organization.
    1. Click Create OAuth client.

    2. In the Application type drop-down list, select Web application.

    3. In the Name field, enter a name to help you identify the application.

    4. In the Authorized redirect URIs section, add the redirect URIs that you have obtained from Yeastar P-Series Software Edition.
      Important: Do NOT add the public IP, as IP address can't be used as the SSO redirect URI due to Google restriction.

    5. Click Create.

      Access credentials are created and displayed in the pop-up window.

    6. Copy and note down the client ID and client secret, which are required for the subsequent configuration in Yeastar PBX.

      Note: If you don't see the client secret, click Download JSON to get the credentials, or refer to the instructions below.

Step 3. Connect Yeastar PBX and Google Workspace

Enter the obtained client ID and client secret into Yeastar PBX to implement the integration.

  1. Access the configuration page of Google Workspace integration.

    1. Log in to PBX web portal, go to Integrations > Collaboration.
    2. On the right of Google SSO, click Integrate.
  2. In the Certificates & Secrets section, paste the credentials that you have obtained from Google Workspace.

  3. Click Save.

    You are redirected to the Google sign-in page.

  4. Sign in to your Google Workspace super admin account and authorize the web application to access user data within your organization.

  5. On PBX web portal, click OK to close the dialog box.

Result

The status of the integration displays Connected, indicating that the PBX is successfully connected to your Google Workspace.

What to do next

Synchronize Users from Google Workspace to Yeastar P-Series Software Edition.