WSO2 Single Sign-On (SSO) login for Magento [SAML] can be achieved by using our Magento SAML SP Single Sign-On (SSO) plugin.
Our SSO solution will make Magento SAML 2.0 compliant Service Provider establishing trust between the Magento site and WSO2 to securely authenticate and login users to the Magento site. Our Magento Single Sign-On (SSO) solution helps to
secure Magento sites behind the SSO login so that users are authenticated using their WSO2 login credentials. Seamless support for advanced SSO features like Attribute / Custom Mapping, Role Mapping etc.
SAML allows information to be exchanged between Service Providers and Identity Providers; SAML is the integration of Service Providers and Identity Providers. When a user attempts to log in, your Service provider delivers SAML assertions to Identity Provider, which contain information about the user. The assertion is received by Identity Provider, which validates it against your Service Provider settings before allowing the user access to your org.
Here we will go through a guide to configure SAML Single Sign-On SSO login between Magento site and WSO2 by considering WSO2 as IdP (Identity Provider) and Magento as SP (Service Provider). Our SSO plugin
provides Unlimited user authentications from WSO2. To know more about other features we provide in you Magento SAML Single Sign-On (SSO) plugin, you can click here.
Pre-requisites : Download And Installation
- Download the miniOrange SAML SP Single Sign-On (SSO)plugin from Magento Marketplace.
- Go to magento root directory.
- Create the new directories MiniOrange/SP inside the app/code directory.
- Run the following commands on command prompt to enable the plugin
1. php bin/magento setup:upgrade
2. php bin/magento setup:di:compile
Magento Single Sign On SSO login with Azure AD, Azure B2C, ADFS, Okta, Keycloak, Salesforce, Ping, Bitium, Gsuite, Shibboleth & many SAML IdPs [24/7 SUPPORT]
Steps to configure WSO2 SAML Single Sign-On (SSO) Login into Magento SAML SP
1. Setup WSO2 as IdP (Identity Provider)
Follow the steps below to configure WSO2 as IdP for Magento
Configure WSO2 as IdP
- In the Magento SAML SP SSO plugin, navigate to Service Provider Metadata tab. In this tab you will find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure WSO2 as the Identity Provider.
- Login to your WSO2 admin console.
- Select Add under Service Provider tab from the left navigation menu.
-
In the Add New Service Provider page, configure the following:
- Select Mode: Manual Configuration
- Service Provider Name: Magento
- Service Provider description: (Optional) Enter a description
- Click on Register button.
Basic Information
- Select SP Certificate Type: Use SP JWKS endpoint
- SaaS Application: Checked (Optional)
Claim Configuration
- Select Claim mapping Dialect: Use Local Claim Dialect
- Click on Add Claim URI you can add multiple claims/attributes for Attribute Mapping (such as
emailaddress, firstname, lastname, telephone, etc).
- Subject Claim URI: https://wso2.org/claims/fullname
Role/Permission Configuration
- Expand the Role/Permission Configuration section, and then expand the Permissions as well as the Role Mapping sections.
- Click Add Permission and specify the service provider specific permission that you want to add.
- Click Add Role Mapping and enter appropriate values for the Local Role as well as the Service Provider Role.
Inbound Authentication Configuration
- Go to SAML2 Web SSO Configuration.
- Click on Configure.
- In Register New Service Provider page, select Mode as URL Configuration.
- Copy the Metadata URL from Service Provider Metadata tab in the plugin.
- Paste the URL in the text box under Upload Service Provider Metadata from Url.
- Click on the Upload button.
- Click on the OK button.
Identity Provider Metadata
- Under Inbound Authentication Configuration, click on SAML2 Web SSO Configuration.
- Beside the Issuer of your Service Provider. Click on Edit button.
- You can verify the details of your Service Provider here.
- Check the Enable Attribute Profile and Include Attribute in the Response Always for Attribute Mapping.
- Click on Download IDP Metadata button.
- Click on Update button.
- Keep this IDP metadata handy for configurations in the plugin.
You have successfully configured WSO2 as SAML IdP (Identity Provider) for achieving WSO2 SSO login into your Magento Site.
2. Configure Magento as SP (Service Provider)
- Copy SAML Entity ID, SAML Single-Sign-On Endpoint URL and x.509 certificate from Federation Metadata document and paste it in IdP Entity ID or Issuer, Single Sign-on Service URL, x.509 Certificate fields respectively in the plugin.
IdP Entity ID or Issuer |
SAML Entity ID in the Federation Metadata document |
Single Sign-On Service URL |
SAML Single-Sign-On Endpoint URL in the Federation Metadata document |
X.509 Certificate |
x.509 Certificate in the Federation Metadata document |
- Click on Save button to save all your settings.
- To check if your Magento as SP is configured correctly, click the Test Configuration button.
3: Attribute Mapping (Optional). *This is Premium feature.
- Attributes are user details that are stored in your Identity Provider.
- Attribute Mapping helps you to get user attributes from your Identity Provider (IdP) and map them to Magento user attributes like firstname, lastname etc.
- While auto registering the users in your Magento site these attributes will automatically get mapped to your Magento user details.
- Only NameID can be mapped to Magento's Email and Username characteristics with the free plugin. Multiple user attributes from the IdP, on the other hand, can be mapped to Magento attributes in the premium version of the plugin. You can map custom attributes that you've added to your IdP in addition to the default attributes.
- When a user performs SSO, the NameID value sent by the IdP will get mapped to the email and the username of the Magento user.
Username: |
Name of the username attribute from IdP (Keep NameID by default) |
Email: |
Name of the email attribute from IdP (Keep NameID by default) |
Group/Role: |
Name of the Role attribute from Identity Provider (IdP) |
- You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.
4: Role Mapping (Optional). *This is Premium feature.
- You can specify a default role in the free plugin that will be allocated to all non-admin users when they conduct SSO.
- Go to Attribute/Role mapping tab and navigate to Role Mapping section.
- Select the Default Role and click on the Save button.
In this Guide, you have successfully configured WSO2 SAML Single Sign-On (WSO2 SSO Login) choosing WSO2 as IdP and Magento as SP using Magento SAML Sigle Sign-On (SSO) Login plugin .This solution ensures that you
are ready to roll out secure access to your Magento site using WSO2 login credentials within minutes.
Additional Resources
If you are looking for anything which you cannot find, please drop us an email on magentosuppor@xecurify.com