Google SSO
Overview
Single Sign-On (SSO) is an authentication mechanism that allows users to access multiple applications with a single set of login credentials. XCALLY supports SSO through Google authentication, enabling users to sign in using their Google credentials (Gmail and password).
The Google SSO functionality is available only for WebRTC Agents and not for Phonebar Agents.
Requirements
XCALLY Configuration: Ensure that the Single Sign-On (SSO) option is enabled in the General Settings of the XCALLY platform.
Google Account: Users (agents, admins, etc.) must log in to their Google account using the same Gmail address that is configured in the XCALLY Staff Settings.
Browser: Users must be logged into their Google account in the browser (if they are using Chrome, they can simply click the red button to authenticate).
Google Console Configuration
Step 1: Create a Project
Log in to the Google Developers Console using your Google credentials.
In the top left corner, open the Navigation Menu, go to IAM & Admin, and click on Create a Project.
Fill in the required fields (project name, billing account, etc.), and click Create.
Step 2: Generate Credentials
Select the specific Project you want to generate the credentials for, in the Google Cloud top bar
From the Navigation Menu, go to APIs & Services > Credentials.
In the OAuth Consent Screen section, configure the consent screen by adding the necessary details about your application to manage credentials for calling Google APIs and Sign in with Google
Click Create Credentials.
Select OAuth Client ID and choose Web Application as the application type.
Under Authorized Redirect URIs, add the URI specific to your Motion server: https://{{MOTION_IP}}/api/auth/google/callback and click on Create
Google will generate the credentials on a dialogue window:
You will no be able to view or download the client secret once you close the dialogue window. Make sure to copy or download the data before closing it.
Save these values:
CLIENT ID
CLIENT SECRET
REDIRECT URI
Server Configuration
Access the SSH Console
Run the following commands:
su motion
cd /var/opt/motion2
nano .env
In the
.envfile, uncomment (remove the#) from the Google-related configuration lines:
Replace
CLIENT_ID,CLIENT_SECRET, andREDIRECT_URIwith the values you obtained from the Google Developer Console.
GOOGLE ID='CLIENT ID'
GOOGLE SECRET= 'CLIENT SECRET'
DOMAIN: 'REDIRECT URI'
Press CRTL+X
Press Y to save changes
Press Enter to confirm the file
To apply the changes, re-initialize the XCALLY Motion V3 application:
npm run initialize
Note: This command will restart the Motion Services, so ensure that no active processes are interrupted.
Check that the services are running properly by executing:
pm2 list
Once the configuration steps are complete and the services have been reinitialized, Google SSO will be ready to use for WebRTC Agents.