Setup User Provisioning (SCIM) into Drupal with AWS
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 AWS 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 AWS. It is compatible with Drupal 9, and Drupal 10.
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:
- Once the module is installed, navigate to the Configuration tab of the Drupal site and select miniOrange User Provisioning.
- Navigate to the User Provisioning tab of the module and click on the Configure button under the Changes from Drupal to Provider (SCIM Client) section.
- Enable the Enable SCIM Client API Integration checkbox.
Configure AWS as SCIM Server:
- Log into the AWS Admin console.
- Search for IAM in the search bar and click on the IAM Identity Center (successor to AWS Single Sign-On).
- Navigate to the Setting tab from the left navigation panel.
- Under the Actions dropdown, click on Manage Provisioning.
- Copy the SCIM Base URL
- Navigate to the Drupal site and paste the copied SCIM Base URL under the SCIM Base URL text field.
- Navigate to the AWS console and click on the Generate Token button.
- Copy the generated Access token.
- Navigate to the Drupal site and paste the copied Access token under the SCIM Bearer Token text field.
- Click on the Save and Test Credentials button.
- Once the test is successful, the following success message will be shown on the screen.
Attribute Mapping:
- Once done with the configuration, scroll down to the Attribute Mapping section.
- From the Drupal User Attribute dropdown, select the user attribute to map with the SCIM Provider Attribute.
- Click on the Next Step button.
How Provisioning Works?
The module supports 3 types of provisioning:
- Manual/On-Demand Provisioning
- Automatic Provisioning
- Scheduler-based Provisioning.
- Choose your preferred provisioning option.
In Manual/On-Demand Provisioning, the user is manually provisioned from the Drupal site to the AWS application..
Configure Manual/On-Demand Provisioning
- Enable the Manual/On-Demand Provisioning and 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 under the Manual Provisioning column.
- Search for the user you want to provision to the Drupal Server site and click on the Submit button.
- Once the user is successfully provisioned to the application, a success message is displayed.
- The status of the user in the AWS application can also be checked by navigating to the Users tab in the left navigation panel of the AWS console.
In Automatic Provisioning whenever any CRUD operation(s) is performed on the user in the Drupal site, the same CRUD operation(s) is automatically performed on the user in the AWS Application at the same time (on the fly).
Configure Automatic Provisioning
- Enable the Automatic Provisioning and select the Provisioning operations (i.e. create, update, deactivate, delete users ) as per your requirements and click on the All Done button.
How Automatic Provisioning Works?
1.By Admin Account:
- 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 and click on the Create new account button.
- The status of the user can be checked in the AWS application by navigating to the Users tab.
2. By registering a new user from the login register window:
- Navigate to the create user window {Base URL}/user/register.
- Enter the user information and click on the Create new account button.
- The status of the user can be checked in the AWS application by navigating to the Users tab.
You can see the user has been successfully provisioned to the Drupal Server site.
Congratulations, you have successfully set up AWS as the SCIM Server and Drupal as the SCIM Client.
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!
