Magento Single Sign-On (SSO) | Setup Magento 2 SSO using SAML or OAuth Protocol

Pre-requisites : Download And Installation

Installation using Composer:

• Purchase the miniOrange OAuth / OpenID Connect Single Sign On 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 miniorange-oauth-sso:{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 OAuth OpenID Connect Single Sign-On extension zip from here.
• Unzip all contents of the zip inside the MiniOrange/OAuth directory.

{Root Directory of Magento} app code MiniOrange OAuth

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

php bin/magento setup:di:compile

php bin/magento setup:upgrade

OAuth / OpenID Connect Single Sign On – SSO (OAuth Client)

By miniOrange

(1)

Magento OAuth OpenID Connect SSO extension allows login (Single Sign-On) into Magento with your Azure AD, Azure B2C, AWS Cognito, WSO2, Okta, LinkedIn, Google, Facebook, Slack, Discord or other custom OAuth 2.0 providers [24/7 SUPPORT]

 Tested with 2.4.5

Get this plugin

Steps to Configure Magento 2 as OAuth Client

1. Setup OAuth 2.0 compliant Provider

• Set up Custom OAuth Provider by configuring the Callback URL provided in the miniOrange OAuth Client Single Sign-On (SSO) extension.

• You will need to collect the Scope and Endpoints provided from your provider to configure the OAuth Client Single Sign-On (SSO) extension
• You will get the Client ID and Client Secret from your OAuth provider, keep the Client ID and Client Secret handy as it will required later to configure Magento OAuth Single Sign-On (SSO) extension.

You have successfully configured your OAuth Provider for achieving your OAuth provider Single Sign-On (SSO) with Magento for user authentication.

2. Configure Magento 2 as OAuth Client

• After successfully configuring your Custom OAuth Provider, go to OAuth Settings tab and enter the OAuth Provider Name as well as Client ID, Client Secret, Scope and endpoints. (You will get these credentials from your custom OAuth provider)
• Click on the Save button to save the settings in Magento OAuth SSO extension.
• Click on the Test Configuration button.

• You will see all the values returned by your OAuth Provider to Magento in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.
• Go to the Sign In Settings tab in Magento OAuth SSO extension and check options to enable SSO on your Magento site.

• You have successfully configured your Magento 2 as an OAuth Client. You will see the SSO button on your frontend. Click on the button and test the SSO .
  
  

Attribute / Custom Attribute Mapping (Optional). *This is Premium feature.

1.1: Attribute Mapping (Optional). *Available in Premium Versions.

• You can map attributes in the Attribute Mapping tab. Only username and email are allowed to be mapped in free version of the extension. However, in the premium version of the extension, you can map various attributes coming from your OAuth Provider to the attributes present in your Magento site.

1.2: Custom Attribute Mapping (Optional). *This is Premium feature.

• Enter your table name in Table field.
• Enter attribute name as your column name (in the respective table)
• Click on Add button for adding custom magento attribute and map the respective field with the attribute receiving from your identity provider
• Click on save button for saving the configuration in Magento OAuth SSO extension.
• You can also delete the configuration by entering the name in attribute name field and then click on delete button.

Role Mapping (Optional). *This is Premium feature.

• You can specify a default role in the free extension that will be allocated to all non-admin users when they conduct SSO.
• Go to Attribute/Role mapping tab in Magento OAuth SSO extension and navigate to Role Mapping section.
• Select the Default Role and click on the Save button.

Try out the free version of the module so that you will get to know the basic functionality and the behaviour of the module in your environment before purchasing. If you face any issues with the or have any other requirements you can drop us a email at magentosupport@xecurify.com

In case you face any issues or have any questions in mind, please feel free to reach out to us by clicking on the Support tab or by clicking here. If you want, you can also mail us your query at magentosupport@xecurify.com.

Magento OAuth client supports various OAuth providers/servers like ADFS, Bitrix24, WHMCS, Square Connect, WSO2, Windows, Gigya, Dash 10, Foursquare, Harvest, MailChimp, Huddle, Ustream, Yammer, RunKeeper, SoundCloud, Pocket, Nest, Heroku, DropBox, Buffer, Hubic, Deezer, Delicious, Bitly, Mondo, Netatmo, Wechat, Weibo, Shibboleth, Invision Community, HR Answerlink/Support center, Blizzar,Swiss-Rx-Login (Swiss RX Login), Procore, Diaspora and many more.