Drupal Bitrix24 Single Sign-on with OAuth Client
Overview
Drupal OAuth Client module enables Single Sign-On i.e. SSO for a Drupal site with
any Identity Provider using OAuth or OpenID connect protocol. Here we will go through the steps to configure the
module with the Bitrix24. Once this configuration is done, users will be able to log in to the Drupal site using
their Bitrix24C credentials.
The integration of Drupal with Bitrix24 simplifies and secures the login process, completely removing the
need to store, remember, and reset multiple passwords.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Custom OAuth 2.0 Provider from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy. It will require to setup Bitrix24 as OAuth provider.
- Enter the application name in the Display Name text field. For example, Bitrix24.
Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.
Setup Bitrix24 as an OAuth Provider:
- Go to Bitrix24 and sign up/login to register a new app.
- 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
- Click on Add Application as shown in the image below.
- Fill up the form according to your use case and click on the Save button to save your settings.
- Copy your Application ID, Application Key, and following URLs, it will require to configure Drupal as OAuth client.
Integrating Drupal with Bitrix24:
- Go to miniOrange OAuth Client module.
- In Configure OAuth tab, Paste the copied Application (client) ID and Client Secret from Bitrix24 into the Client ID and Client Secret text field
- Enter the Bitrix24 details in the respective fields as per below table and click Save Configuration button.
| Drupal Fields | Bitrix24 |
| 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= |
Test Connection between Drupal and Bitrix24:
- After successfully saving the configurations, click on Perform Test Configuration button to test the connection between Drupal and Bitrix24.
- On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login into the Bitrix24. After successfully logging into the Bitrix24, you will be provided a list of attributes received from the Bitrix24C.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
Note: Mapping the Email Attribute is mandatory for your login to work.
- On the Attribute & Role Mapping tab, please select the attribute under which the email of the user is received from the Email Address drop-down menu. Similarly, you can select the suitable option from the Name Attribute drop-down menu.
- Then, scroll to the bottom and click on the Save Configuration button.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with Bitrix24 link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below:
Congratulations! You have successfully configured Bitrix24 as OAuth/OpenID Provider and Drupal as an OAuth Client.
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
Troubleshooting:
More FAQs ➔Getting error: 'Username not received. Check your
Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping
configuration.' 
Follow the steps mentioned HERE
I am getting "Client Credentials were not found in
the headers or body"
when I try to perform test configuration
Follow the steps mentioned HERE
After I click on the logout in Drupal, it sends me back to
the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but
automatically logs me in with same user
The logout functionality you've mentioned here is the default behavior of a module. It's logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
I purchased the paid Drupal module and replaced it with
the free module, but still I am not able to use paid features.
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]
Contact us
[MO_CONTACT_US]
