How to Set Up Drupal as a SCIM Client for User Provisioning & Sync

Overview

The User Provisioning & Sync Module allows you to automatically create (provision) and delete (deprovision) user accounts and have them synced bidirectionally between Drupal and any Identity Provider. Any changes or updates done to the user information can also be synced between the SCIM Client and Server.

Installation Steps

• Using Composer
• Using Drush
• Manual Installation

• 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

Configuration Steps

1. Setup Drupal as SCIM Client:

• After successful installation, go to the Configuration tab and select the miniOrange User Provisioning module.

• Go to the User Provisioning tab of the module and click the Configure button under the Changes from Drupal to Provider (SCIM Client) section.

• Follow the steps below under Configure Drupal as SCIM Client:
• Turn on the Enable SCIM Client API Integration toggle.
• Enter the SCIM 2.0 Base URL and SCIM Bearer Token from the server site into the respective text fields, then click the Save and Test Credentials button.



• Once the test is successful, a success message will appear.

2. Attribute Mapping:

• After successfully testing the configuration, scroll down to the Attribute Mapping section.
• Select the Drupal User Attribute you want to map to the corresponding SCIM Provider Attribute, then click the Save mapping button.
• Once done, click on the Next Step.

3. SCIM Client Provisioning:

• The User Provisioning & Sync module supports three types of provisioning:
• Manual/On-Demand Provisioning: In Manual/On-Demand Provisioning, users are created, updated, deactivated, or deleted by the admin as needed.
• Automatic Provisioning: With Automatic Provisioning, when you create, update, or delete a user on one Drupal site, the same changes happen automatically on the other site. It keeps both sites in sync without manual work.
• Scheduler-based Provisioning: This allows you to perform CRUD operations on any Drupal user in your provider during the CRON run.

• Choose the Provisioning Types based on your preference.

• Select the Provisioning Operations (create, update, deactivate, delete) as needed.

4. Enable Role Filter:

• This feature allows provisioning of users who have any of the selected roles. Only those users will be sent to the server site others will be skipped.

5. Enable Group Provisioning:

• This feature allows you to send user roles from Drupal as groups to other (server) site.


Note: Default roles of Drupal will not be synced.



• Click on the All Done button.

6. How does Manual/On-Demand Provisioning work?

• Click the Perform Manual Sync button under the Manual Provisioning column.

• Search for the user you want to provision to the server site, then click the Submit button.

• Once the user is successfully provisioned to the application, a success message will be displayed.

• To confirm the changes, go to the server site and check the status of the provisioned user.

7. How does Automatic Provisioning work?

• Automatic Provisioning will help you to provision users based on any of the following events:
• Admin Interface: When admins or authorized users manually create, update, or delete a user’s account through the Drupal admin panel.
• User Account Change: When users create, update, or delete their own information form using the user/{user_id}/edit page or a custom form.
• 3rd Party Modules: When a user is created or updated on the Drupal site through third-party modules, apps, or custom code.

• For example, let’s see how automatic provisioning works 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 user details, then click the Create new account button.

• To confirm the changes, go to the server site and verify the status of the provisioned user.

Congratulations! You’ve successfully set up Drupal as the SCIM client.

If the provisioning was not successful, please contact us at drupalsupport@xecurify.com. Kindly include a screenshot of the error window, and we will assist you in resolving the issue and guide you through the setup.