SugarCRM OpenID Connect Single Sign-On (SSO) Module By Gluu#
The oxd OpenID Connect single sign-on (SSO) plugin for SugarCRM enables you to use a standard OpenID Connect Provider (OP), like Google or the Gluu Server, to authenticate and enroll users for a SugarCRM site.
In order to use the SugarCRM module you will need to have a SugarCRM site, standard OP (like Google or a Gluu Server) and the oxd server.
This plugin is compatible with sugarCRM versions: 6.5 - 7.6
If you want to stand up your own OP server, you can deploy the free open source Gluu Server. Otherwise we recommend using Google
Download SugarCRM Plugin#
You can download the plugin from the Github source.
Upload the Plugin#
Log in to your SugarCRM Admin Console
Navigate to Admin and click on
Choose downloaded module and click on
OpenID Connectand select
OpenID Connect (SSO) Module by Gluu
to check the installation and activated plugin
In your SugarCRM admin dashboard you should now see the
OpenID Connect link on the top left hand menu.
Click the link to navigate to the General configuration page.
In the server settings section of the plugin configuration page you will need to enter information about your OP, your oxd server, and where you want to redirect users after logout.
A short description of each field follows:
URI of the OpenID Provider: Insert the URI of the OpenID Connect Provider here. If you are using Google as your OP, this will simply be
https://accounts.google.com. If you are using another OP it will be something like
Custom URI after logout: Provide a URL for a landing page to redirect users after logout of the WP site, for instance
https://example.com/thank-you. If you don't have a preferred logout page we recommend simply entering your website homepage URL. If you leave this field blank the user will see the default logout page presented by SugarCRM.
oxd port: Enter the oxd-server port, which you can find in your
If your OpenID Provider supports dynamic registration no additional steps are required.
If your OpenID Connect Provider does not support dynamic registration (like Google), after clicking register two additional fields will be exposed where you need to enter your
client_secret. Both values need to be obtained from the OP. To generate your
client_secretuse the redirect uri:
Add the following lines to the config_override.php in your SugarCRM setup, after you complete the registration.
``` $sugar_config['http_referer']['list'] = your-openid-provider.uri`; $sugar_config['http_referer']['actions'] =array('index', 'ListView', 'DetailView', 'EditView', 'oauth', 'authorize', 'Authenticate', 'Login', 'SupportPortal', 'Wizard', 'index', 'ListView', 'DetailView', 'EditView', 'oauth', 'authorize', 'Authenticate', 'Login', 'SupportPortal', 'SetTimezone' ); ```
If you are using a Gluu server as your OpenID Provider, you can make sure everything is configured properly by logging into to your Gluu Server, navigate to the
OpenID Connect >
Clients page. Search for your
oxd id. If it's present in the OP, everything worked.
Enrollment and Access Management#
In the enrollment and access management section of the plugin configuration page you can decide, (1), how new user registrations will be handled, and, (2), what role new users will receive upon registration.
You have three options for new user registrations:
Automatically register any user with an account in the OpenID Provider: By setting registration to automatic, any user with an account in the OP will be able to dynamically register for an account on your SugarCRM site
Only register and allow ongoing access to users with one or more of the following roles in the OP: Using this option you can limit registration to users that have a specified role in the OP, for instance
SugarCRM. Each time the user authenticates they will need to have this scope present in order to be approved for access (i.e. if you remove this scope from the users profile in the OP, the user would be denied access). This is not configurable in all OP's. It is configurable if you are using a Gluu Server. Follow the instructions below to limit access based on an OP role
Disable automatic registration: If you choose to disable automatic registration, you will need to manually add a user in SugarCRM for each person that needs access. Make sure that when you add the user in SugarCRM, you use the same email they have registered in the OP
New User Default Role: Use this field to specify which role new users are assigned upon registration. If you have automatic registration set to disabled, you will have the opportunity to specify the users role during manual account creation
Role Based Enrollment#
In order to implement role based enrollment, you will need to make changes in both the plugin and the Gluu Server.
Perform the following in the Plugin:
- In the Enrollment and Access Management section, choose the option:
Only register and allow ongoing...
- Add a name for the role want to use to enforce access (e.g.
- Save the configuration
- Navigate to the OpenID Connect Configuration tab
- In the User Scopes section, check the box for
- Save your settings
Perform the following in your Gluu Server:
- Navigate to your Gluu Server admin GUI ("oxTrust")
- Click the
Userstab in the left hand navigation menu
- Find the person(s) who should have access
- Click their user entry
- Add the
User Permissionattribute to the person and specify the same value as in the plugin. For instance, if in the plugin you specify that enrollment should be limited to users with role =
SugarCRM, then you should also have
SugarCRMin the user entry. See a screenshot example
- Update the user record
Now only users with the role
SugarCRM in the Gluu Server will be able to gain access to your SugarCRM site.
OpenID Connect Configuration#
Navigate to the OpenID Connect Configuration tab to set your preferences for scopes and authentication.
Scopes are groups of user attributes that are sent from the OP to the application during login and enrollment. By default, the requested scopes are
openid. If you want more information about the users, you can request additional scopes.
To view your OP's available scopes, open a web browser and navigate to
https://<hostname>/.well-known/openid-configuration. For example, if you are using Google the the OP, you can see the available scopes in the Google's OP configuration.
If you are using a Gluu server as your OpenID Provider, you can view available scopes by navigating to the OpenID Configuration page as described above, or within oxTrust by navigating to
OpenID Connect >
In the authentication settings, you have two options:
Bypass the local SugarCRM login page and send users straight to the OP for authentication: If you would like to bypass SugarCRM's default login page and send users straight to the OP, check this box (recommended). When this option is left unchecked users will see the following screen when trying to login:
acris an OpenID Connect specific value that enables applications to request a specific type of authentication from the OP, e.g. SMS based two factor authentication, or FIDO U2F tokens. If you are using Google as your OP, you will have to accept their default authentication mechanism. If you are using a Gluu Sever, you will be able to request any supported form of authentication. To view the OP's supported ACR values, navigate to your OpenID Provider configuration page,
acr_values. In the
Select acrfield you can choose your preferred authentication mechanism. If
none, users will be sent to pass the OP's default authentication mechanism
Gluu Server Configuration#
If you are using a Gluu Server as your OP, you will need to configure Gluu to release the email claim. You can do so by following the below steps:
Log into your Gluu Server dashboard ("oxTrust") and navigate to
Set the default scope field to
Claimsfield, click the
Add Claim, search for email, and add it
Now navigate to
Attributesand make sure that the
Active. If it is not, click on the
Statusfield where you can change the value to Active. Click update
To use Google as the OP, you will need to obtain a Client ID and Secret at Google. To generate your
client_secret at Google use the redirect URI:
Please report technical issues and suspected bugs on our support page.