Configure Bitrix24 Single Sign-On (SSO) with Joomla OAuth Client Plugin
Overview
Integrating Bitrix24 Single Sign-On (SSO) with Joomla using the OAuth 2.0 protocol is easy with the miniOrange
Joomla OAuth/OpenID Connect SSO plugin. This plugin enables secure logins by allowing users to authenticate with
their Bitrix24 OAuth Provider credentials.
For more details on the features and plans of the Joomla OAuth Single Sign-On plugin, visit our Joomla OAuth Client
Plugin webpage.
Configuration Steps
In this configuration, Bitrix24 functions as the OAuth server, while Joomla allows users to log in with their Bitrix24 credentials by utilizing the Joomla OAuth Client Plugin.
Step 1: Install Joomla OAuth Client Plugin
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Get Started!
- Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also search for custom OAuth or custom OpenID application in the search bar, and configure your own custom provider.
- After selecting your OAuth provider, you will be redirected to the Step 1 [Redirect URL] tab. Now copy the Callback/Redirect URL which we will use to configure Bitrix24 as OAuth Server, then click on the Save & Next button.
Step 2: Configure Bitrix24 as OAuth Server
- First of all login to your Bitrix24 Account.
- Under the Add Your App, select For Developers option to continue. Click on the Start Free button.
- From the navigation menu on the left, scroll down and select Application option. Now click on the Add Application option on the top to add an app in Bitrix24.
- You will be redirected to the below page. Click on Add Application.
- Click on Add Application as shown in the image below.
- Fill up the form according to your use case. Enter the Redirect / Callback URL , in Specify URL field and click on the Save button to save your settings on Bitrix24 application.
Step 3: Configure Client ID & Secret
- Now copy your Application ID and Application Key and save it in your miniOrange OAuth Client plugin under Client ID and Client Secret fields respectively.
- Go back to your Joomla Dashboard. Then go to Step 2 [Client ID & Secret].
- Paste the Client ID, Client Secret and Domain. Also Set Client Credentials In header then click on Save Settings. Once Settings are saved then click on Save Configuration.
- Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure Bitrix24 as a custom OAuth or OIDC provider.
| Scope | entity, user, log, department |
| Authorize Endpoint | https://[your-id].bitrix24.com/oauth/authorize |
| Access Token Endpoint | https://[your-id].bitrix24.com/oauth/token/ |
| Get User Info Endpoint | https://[your-id].bitrix24.com/rest/user.current.json?auth= |
| Set Client Credentials | In Both (In Header and In Body) |
Step 4: Configure Attribute Mapping
- User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
- Go to Step 3 [Attribute Mapping] tab and click on Test Configuration button.
- You will be able to see the attributes in the Test Configuration output as follows.
- Now go to the Step 3 [Attribute Mapping] tab and Select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.
Step 5: Setup Login/SSO URL
- Now go to Step 4 [SSO URL] tab, here copy the Login/SSO URL and add it to your Site by following the given steps.
- Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.
