What it’s about
Single sign-on (SSO) is an access management function that enables users to log in with a single set of identity credentials to multiple accounts, software, systems, and resources.
XCALLY gives its users the possibility to access XCALLY using Google credentials (gmail and password).
For agents, SSO feature is available only for WebRTC Agents (and not for Phonebar Agents)
How to set up
XCALLY Configuration
Please check in the General Settings the Single Sign-On property has been turned on
Creating a Google API Console project and client ID
| Info |
|---|
For any additional information please refer to the Official Google Documentation here |
:
From General Setting Menu, access the SSO section
Enable Google SSO
In order to make the Google SSO work, XCALLY users (agents, users, admin) must login to Google with the same GMAIL configured in the XCALLY Staff Settings.
If they are already logged into the Chrome browser, they need just to click on the red button.
Google Configuration
Access to the Google Developers Console (https://console.developers.google.com)
- Create a project if you need
- Now you can add the credentials to access the APIs, click "Create credentials" and select "OAuth client ID"
- Configure the consent screen if required
- Provide in the required information in the consent screen form (please refer to the Google Official Documentation for more information)
- Once you complete the consent screen configuration, you can continue to creating credentials
Insert in the authorized URIs field the URI related your Motion server
with Google credentials
Create a new Google API Consoleproject
From the Navigation Menu, choose IAM & Admin and select Create a Project
Fill the required fields and click on Create
Generate Credentials
Select the specific Project you want to generate the credentials for, in the Google Cloud top bar
From the Navigation Menu, choose APIs & Services and select Credentials
Remember to configure the OAuth consent screen with information about your application.
Click on Create Credentials
Select OAuth client ID
Choose Web Application as app type
Enter the Redirect URI related to your Motion server: https://{{MOTION_IP}}/api/auth/google/callback
- Save and get you client credentials
Motion server configuration
edit the file
Click on Add URI and Create
Google will generate the credentials:
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
User authentication
In order to use the Google SSO, the XCALLY users must have the proper Google account set as "email" in the Motion Staff section.
If they are already logged into the Chrome browser, they need just to click on
Otherwise, Google will ask them the account credentials
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| hidden | true |
|---|
nano .env
Uncomment (remove the # ) the Google-related rows:
| Code Block | ||
|---|---|---|
| ||
google: {
clientID: process.env.GOOGLE_ID || 'id',
clientSecret: process.env.GOOGLE_SECRET || 'secret',
callbackURL: (process.env.DOMAIN || 'https://YOUR_MOTION_IP') + '/api/auth/google/callback'
} |
with the Google application ID, example:
| Code Block | ||
|---|---|---|
| ||
google: {
clientID: process.env.GOOGLE_ID || '1234567890-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com',
clientSecret: process.env.GOOGLE_SECRET || 'abc-123456abcdefghijklmn',
callbackURL: (process.env.DOMAIN || 'https://pbx2.xcally.com') + '/api/auth/google/callback'
} |
restart the motion service to apply the change
| Code Block |
|---|
su motion
pm2 restart motion2 |
Insert the required values with those generated in the Google Configuration:
GOOGLE ID='CLIENT ID'
GOOGLE SECRET= 'CLIENT SECRET'
DOMAIN: 'REDIRECT URI'
Press CRTL+X
Press Y to save changes
Press Enter
Re-initialize the Xcally Motion V3 application for the variables changes to take effect, using the following commands:
npm run initialize
| Note |
|---|
Remember that this command restart Motion Services! |
Make sure that services are up by running the command:
pm2 list
The Google SSO is ready to be used!