User Provisioning and Sync using Joomla as SCIM Server and Drupal as SCIM Client
Syncing user information across the applications that use Drupal as central Identity Provider is necessary. miniOrange User Provisioning and Sync module ensures that any changes in the user fields/roles are reflected to the connected Joomla application in accordance with the SCIM protocol. This setup guide will walk you through the steps to configure manual, automatic, or scheduler-based provisioning with Joomla. It is compatible with Drupal 9, and Drupal 10.
The module also supports a two-way sync between Drupal and Joomla. You can reach out to us at drupalsupport@xecurify.com for one-on-one assistance from a Drupal developer.
Installation Steps
- Download the module:
composer require 'drupal/user_provisioning'
- Navigate to Extend menu on your Drupal admin console and search for miniOrange User Provisioning using the search box.
- Enable the module by checking the checkbox and click on Install button.
- Configure the module at
{BaseURL}/admin/config/people/user_provisioning/overview
- Install the module:
drush en user_provisioning
- Clear the cache:
drush cr
- Configure the module at
{BaseURL}/admin/config/people/user_provisioning/overview
- Navigate to Extend menu on your Drupal admin console and click on Install new module button.
- Install the Drupal User Provisioning and Sync module either by downloading the zip or from the URL of the package (tar/zip).
- Click on Enable newly added modules.
- Enable this module by checking the checkbox and click on Install button.
- Configure the module at
{BaseURL}/admin/config/people/user_provisioning/overview
Steps to configure Drupal as SCIM Client:
- In the Drupal site, once the module is installed, navigate to the User Provisioning tab (/admin/config/people/user_provisioning/provisioning).
- Click on the Configure button under the Changes from Provider to Drupal (SCIM Server) section.
- Enable the Enable SCIM Client API Integration checkbox.
Configure Joomla as SCIM Server:
- Log in to your Joomla site.
- Install and Activate the SCIM User Provisioning module on your Joomla site
- Navigate to the SCIM Configuration tab of the miniOrange SCIM Server module.
- Copy the SCIM Base URL.
- Navigate back to the Drupal site and paste the copied SCIM Base URL under the SCIM Base URL text field.
- Similarly, for the SCIM Bearer token, navigate to the Joomla site and copy the SCIM Bearer Token.
- Head back to the Drupal site and paste the copied SCIM Bearer Token under the SCIM Bearer Token text field.
- Click on the Save and Test Credentials button.
- Once the test is successful you will get a success message.
Attribute Mapping:
- After the successful Test configurations, scroll down to the Attribute Mapping section.
- Select the username attribute you want to map with the SCIM Provider Attribute from the Drupal User Attribute section and click on Next Step.
How Provisioning Works?
The user Provisioning module supports 3 types of provisioning:
- Manual/On-Demand Provisioning
- Automatic Provisioning
- Scheduler-based Provisioning.
- Select the provisioning option as per your requirements.
In Manual/On-Demand Provisioning users will manually sync with the Joomla. It allows provisioning users on an as-needed basis in real time without waiting for the CRON to run. Also, can be used for troubleshooting purposes as well
How to configure Manual/On-Demand Provisioning?
- Enable the Manual/On-Demand Provisioning checkbox.
- Select the Provisioning operations (i.e. create, update, deactivate, delete) as per your requirements and click on the All Done button.
How Manual/On-Demand Provisioning Works?
- Click on the Perform Manual Sync button.
- Search for the user you want to provision to the Joomla site, select the user, and click on the Submit button.
- Once the user is successfully provisioned to the application, you will get a success message.
- To verify is the user is provisioned or not, navigate to the Users tab in the left navigation panel of the Joomla site.
This type of provisioning allows you to sync users with Joomla whenever any CRUD operation(s) is performed on them in Drupal.
How to configure Automatic Provisioning?
- Enable the Automatic Provisioning checkbox.
- Select the Provisioning operations (i.e. create, update, deactivate, delete users) as per your requirements and click on the All Done button.
How to perform the Automatic Provisioning?
Automatic Provisioning will help you provision your users using any of the following events:
- Admin Interface: When administrators or privileged users manually perform CRUD operations on a user’s account via the Drupal admin interface.
- User account change: Whenever users themselves perform CRUD operations on their own information form user/{user_id}/edit or any other custom form.
- 3rd Party Modules: Whenever a user entity is updated/created in the Drupal site using any third-party modules/applications or custom code
Let’s perform Automatic Provisioning using the Admin Interface:-
- Navigate to the People tab (admin/people) in the top navigation bar of the Drupal Client site and click on the +Add user button.
- Fill in the details and click on the Create New Account button.
- You can check the status of the user in Joomla by navigating to the Users tab in the left navigation panel of the Joomla site.
You can see the user has been successfully provisioned to the Drupal Server site.
If the Provision was not successful, please contact us at drupalsupport@xecurify.com. Please send the screenshot of the error window, and we will assist you in resolving the issue and guiding you through the setup.
Need Help? We are right here!
