Magento OAuth / OpenID Connect Single Sign-On (SSO) Setup Guide

Magento OAuth / OpenID Connect Single Sign-On (SSO) Setup Guide


The Magento OAuth / OpenID Connect Single Sign-On (SSO) plugin works with any OAuth provider that conforms to the OAuth 2.0 and OpenID Connect 1.0 standard. This Magento Single Sign On plugin helps you to setup SSO with any OAuth / OIDC Provider.

The plugin can be set up using other Social Media sources, as well as custom OAuth and OIDC providers. It contains a lot of Single Sign-On (SSO) features, like Attribute Mapping for user profiles, Role Mapping, and so on. Click here to read more about the Magento OAuth Single Sign-On (OAuth & OpenID Connect Client) plugin's extra features.

The Magento 2 OAuth & OpenID Connect Single Sign-On (SSO) plugin makes it possible to log into Magento securely using any OAuth and OpenID Connect provider. You can also use alternative OAuth providers, such as Azure B2C, Office 365, and other custom providers, to configure the plugin. Advanced Single Sign-On features such as user profile Attribute Mapping, Role Mapping, and so on are supported.

Click here to know more about other features we provide in Magento OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin

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 {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 OAuth OpenID Connect Single Sign-On extension.
  • 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

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.4

Steps to Configure Magento 2 as OAuth Client

1. Configure Magento 2 as OAuth Client

  • After successful installation, go to the OAuth Settings tab. Now configure your OAuth Provider using the Callback URL provided in this tab.

    magento oauth SSO oauth settings
  • After successfully configuring your OAuth Provider, go to OAuth Provider tab and configure OAuth Provider Name, Client ID, Client Secret, Scope and provided endpoints.
  • Click on the Save button to save the settings.
  • Click on the Test Configuration button.

    magento 2 oauth test Configuration
  • 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 and check options to enable SSO on your Magento site.

    oauth magento 2 Sign in settings
  • You can map attributes in the Attribute Mapping tab. Only username and email are allowed to be mapped in free version of the plugin. However, in the premium version of the plugin, you can map various default attributes coming from your OAuth Provider to the attributes present in your Magento site.
  • Along with the default attributes you can also map custom attributes that you have added in your Oauth Provider.

  • magento oauth 2.0 Attribute mapping
    magento 2 oauth sso custom atrribute mapping
  • In the free plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO. Go to Attribute/Role mapping tab and navigate to Role Mapping section.
  • Select the Default Role and click on the Save button.
  • magento oauth openid single sign on role mapping
  • 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.

    magento oauth SSO button on customer login page
  • 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.

Additional Resources


If you are looking for anything which you cannot find, please drop us an email on magentosupport@xecurify.com

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com