UC Services G Suite Integration V 5.6 R3.0
Page 1 of 14 Overview UC Services is integrated with G Suite to provide clients access to Google Users (Directory) and Contacts. This document walks you through the steps to setup Google to allow for this access and provides outputs that are needed in the UC Services Admin application for con iguring the site for G Suite integration.
Google G Suite is constantly evolving. Before starting, make sure you are using the latest integration guide.
There are two steps which will be described in this document: 1. Setting up Google Users Directory. The UC Suite Admin application will need the Google private key (JSON) ile con iguration of the Google Users Directory feature. 2. Setting up Google Contacts. The UC Suite Admin application requires the API key and the Client ID for the Google Contacts.
Set Google up for API Access 1. Enable the API. Log in to the Google Admin console (go to ‘https:// admin.google.com/’) and select Security. If you do not see Security listed, select More controls and then Security from the options shown in the gray box.
2. Select API reference, and then select the checkbox to Enable API access. Save your changes.
Page 2 of 14 Setup the “UC Services” Project 1. Open "https://code.google.com/apis/console" in your browser. 2. Make sure that your organization is selected (see Fig 1).
Select your organization
Figure 1
3. Click on “CREATE PROJECT”. 4. Enter “UC Services” for the Project name. 5. Click “Create” and wait for your project to be created.
Page 3 of 14 Enable the Admin SDK API ] 1. Select the project that you created found in the “Project name” column by clicking on it.
2. Click the menu in the top left.
3. Click “APIs & Services”. 4. Click “Library”.
5. Search for “Admin SDK” and click it.
6. Click the ‘Enable’ button to enable the API and wait for it to complete.
Page 4 of 14 Create the Service account 1. Click the menu (the three horizontal lines) again in the top left. 2. Click “IAM & Admin”. 3. Click “Service accounts”.
4. Click “Create service account”.
Page 5 of 14
5. Enter “UC Services “ for the Service account name. 6. Click on “Select a role”. 7. Click on “Project”. 8. Click on “Viewer”. 9. Check “Furnish a new private key”. 10. Select JSON for Key type. 11. Check “Enable G Suite Domain-wide Delegation”. 12. Enter “UC Services” for the Product name/ 13. It should look similar to the following.
14. Click “Save”.
15. A ile that will be needed later will be downloaded to your system called “UC Services-
16. Click “CLOSE” to close the dialog and wait for the Project to be created.
Page 6 of 14
17. Click “View Client ID” for the service account and record the value for “Client ID.
NOTE: If you need to go back and retrieve this later then go to https:// console.developers.google.com/, click the menu in the top left, click “IAM & Admin”, click “Service accounts”. Find the service account just created and click “View Client ID” from the Options column.
Delegate G Suite Domain-wide authority to the service account 1. Go to Admin console by opening http://admin.google.com in your browser. 2. Select Security from the list of controls. If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls. If you can't see the controls, make sure you're signed in as an administrator for the domain.
3. Select “Advanced settings” from the list of options.
Page 7 of 14 4. Select “Manage API client access”. 5. Enter the Service account Client ID in the Client Name ield. 6. Enter “https://www.googleapis.com/auth/admin.directory.user.readonly” into the Scopes ield. 7. Click “Authorize”.
Enable Google Directory in UC Server: 1. In a supported web browser open the UC Admin page and log in as the Administrator. 2. Under Applications, select “Google settings”. 3. Enter the email address of the Google Admin User. 4. Click on the red bar shown below. Upload the JSON ile that was downloaded to your default downloads folder.
Enter the Google Admin email address here
Page 8 of 14 Setting up Google Contacts
Prerequisites: • Google account. • Administrator user for the Google Account. • Sign in as the administrator user.
1. Open https://console.developers.google.com/start/api?id=people.googleapis.com in your browser. 2. Select the “UC Services” project. 3. Click “Continue”. 4. Click “Go to credentials”.
Page 9 of 14 On the “Add credentials to your project” screen click “Cancel”.
1. At the top of the next page click “OAuth consent screen”. 2. Select “Email address” of an administrator account. 3. Enter Product name of “UC Services” if not already set. 4. Click the “Save” button.
Page 10 of 14
1. Select the “Credentials” tab. 2. Click “Create credentials” and select “OAuth client ID”.
1. Select Application type of “Web application”. 2. Enter “UC Services Client” for Name. 3. Enter the URL for UC Server in the “Authorized Javascript origins” ield.Click the “Create” button. 4. Record the client ID and the client secret that are shown as they will be needed by the UC Services Admin application.
NOTE: This client ID is necessary to con igure the site for Google Contacts through the UC Services Admin application.
1. Click “OK” to dismiss the dialog. 2. Click the “Create credentials” button again and select “API key”. 3. Record the API key as you will need this in UC Services Admin.
NOTE: This API key is necessary to con igure the site for Google Contacts through the UC Services Admin application.
Click the “CLOSE” button.
Page 11 of 14 Enable Google Contacts in UC Server:
1. In a supported web browser open the UC Admin page and log in as the Administrator. 2. Under Applications, select “Google settings”.
3. Enter the Client ID & API key as shown below.
Enter the Client IDI here
Enter the API key here
Page 12 of 14 UC Server is now con igured for Google G-Suite. Users will need to log in/out to see the change.
Page 13 of 14 How to recover the con iguration information that UC Services needs:
1. Go to https://console.developers.google.com 2. Select the correct project at top of page 3. Click ‘Credentials' 4. Grab information here and enter into our Admin Applications -> Google settings
Page 14 of 14