Setup Guide to configure Google Apps / G-suite User Provisioning ( SCIM ) into Magento

The System for Cross-domain Identity Management (SCIM) is an open standard HTTP based protocol for automating the exchange of user identity information between identity domains, or IT systems. SCIM aims to simplify user provisioning and management in the cloud. For example, as an Identity Provider add, update and delete the user, they are added, updated and removed from the Magento User Profile. To achieve this functionality Google Apps/ G-Suite provides the User Provisioner with SCIM standard.

If your users are using both Google Apps/ G-Suite and Magento 2 website, it is preferred to have all users updated in Magento 2 site without login each time to update user list. miniOrange provides a solution which allows user provisioning into Magento website using SCIM standard.

miniOrange provides a solution by introducing a Magento extenstion to support Google Apps/ G-Suite User Provisioning and allows user to access your website by using their Google Apps/ G-Suite account credential to login into Magento. User Provisioning & Sync extension also allows provisioning with custom Providers. User Provisioning & Sync extention works with any IDP that conforms to the SCIM standard.

Pre-requisites : Download And Installation

Installation using Composer:

• Purchase the miniOrange User Provisioning & Sync extension from magento marketplace.
• Go to My profile -> My Purchases
• Please ensure you are using correct access keys (My Profile - Access Keys)
• Paste the access keys in your auth.json file inside your project
• Use the below command to add the extension to your project.

  "composer require {module_name}:{version}"

• You can see the module name and list of versions in the selector below the extension module name.
• Run the following commands on command prompt to enable the extension.

php bin/magento setup:di:compile

php bin/magento setup:upgrade

Manual Installation:

• Download the miniOrange User Provisioning & Sync extension.
• Unzip all contents of the zip inside the MiniOrange/SCIM directory.

{Root Directory of Magento} app code MiniOrange SCIM

• Run the following commands on command prompt to enable the extension

php bin/magento setup:di:compile

php bin/magento setup:upgrade

Steps to configure Magento as SCIM Server and Google Apps/ G-Suite as SCIM Client (Google Apps/ G-Suite Automatic User Sync and Provision with Magento)

1. Configure Magento as SCIM Server

• Navigate to the SCIM Configuration tab to find the SCIM Base URL and SCIM Bearer Token, which you will keep handy.

2. Setup Google Apps/ G-Suite as SCIM Client

• Login into the Google Admin console.

Note: Sign in using your administrator account.

• From the left menu bar, click on Apps -> select Web and mobile apps.

• Click on Add App and search for "keeper".

• Add the application and configure your SAML Single Sign on configuration.
• Now, navigate to the Autoprovisioning section of the application and enter your required information.

• Paste the SCIM Base URL into the Endpoint URL field and the SCIM Bearer Token into the App authorization field from step 1.

• In the Keeper app, select SAML attribute mapping to map the user attributes.

• Then, click on Save button to save your configuration.
• Now, Turn on Autoprovisioning in the Settings of the app.

• Change the User Access status to On for everyone in the SAML SSO app.

You have successfully configured the Magento User Provisioning & Sync extension with Google Apps/G-Suite.

3. Attribute Mapping

• In the Magento User Provisioning & Sync extension, navigate to the Attribute Mapping tab.
• In the Attribute Mapping section, enter the information and click on Save .

24*7 Active Support

If you face any issues or if you have any questions, please feel free to reach out to us at magentosupport@xecurify.com. In case you want some additional features to be included in the extension, please get in touch with us, and we can get that custom-made for you. Also, If you want, we can also schedule an online meeting to help you configure the Magento SCIM User Provisioning extension.