SAML Single Sign-On (SSO) for Magento using OpenAM as IDP | OpenAM SSO Login
SAML Single Sign-On (SSO) for Magento using OpenAM as IDP | OpenAM SSO Login
OpenAM 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 OpenAM 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 OpenAM 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 OpenAM by considering OpenAM as IdP (Identity Provider) and Magento as SP (Service Provider). Our SSO plugin provides Unlimited user authentications from OpenAM. 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
Installation using Composer:
- Purchase the miniOrange SAML Single Sign On – SAML SSO Login 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 SAML Single Sign On – SAML SSO Login extension.
- Unzip all contents of the zip inside the MiniOrange/SP directory.
{Root Directory of Magento} app code MiniOrange SP
php bin/magento setup:di:compile
php bin/magento setup:upgrade
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 OpenAM SAML Single Sign-On (SSO) Login into Magento SAML SP
1. Setup OpenAM as IdP (Identity Provider)
Follow the steps below to configure OpenAM as IdP for Magento
Configure OpenAM 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 OpenAM as the Identity Provider.
- Login to the OpenAM admin console.
- From the REALMS, select realms, under which you want to create hosted IDP. You will be redirected to the Realm overview page.
- Click on Create SAMLv2 Providers in the Realm Overview page.
- Click on Create Hosted Identity Provider. You will be redirected to the configuration page.
- Configure SAML IDP as given below.
- Name: Name of the SAML IDP
- Signing Key: Select the Signing key from the dropdown.
- New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
- Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.
- Click on the Configure button on the top right corner.
- Verify the configuration from the Federation tab of OpenAM.
Configure Remote Service Provider.
- Login to the OpenAM admin console.
- From the REALMS, select realms, under which you want to configure your application. You will be redirected to the Realm overview page.
- Click on Create SAMLv2 Providers.
- Click on Register Remote Service Provider. You will be redirected to the configuration page.
- Configure the Service Provider as given below.
- Where does the metadata file reside: URL.
- URL of metadata: Configure miniOrange plugin’s SAML Metadata here.
- Circle of Trust: Add to existing.
- Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located.
- Attribute Mapping: Configure user profile attributes for mapping.
- Click on the Configure button on the top right corner.
- Verify the configuration from the Federation tab of OpenAM.
- Provide OpenAM SAML Metadata to Service Provider application(miniOrange plugin) and you can download the OpenAM metadata using the URL given below. [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp In case if you have multiple realms and hosted identity Provider configured then use the URL given below. [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp?entityid=[IdPentityID]&realm=/realmname
You have successfully configured OpenAM as SAML IdP (Identity Provider) for achieving OpenAM 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.
- Click on Save button to save all your settings.
- To check if your Magento as SP is configured correctly, click the Test Configuration button.
| 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 |
3. Sign-In Settings
- Navigate to Sign-in Settings tab. Here you find the option the enable the login link on Admin*/Customer Login Page (*Admin SSO is available in the premium versions)
- If you want to initate SSO from any page you can also use the SSO link provided in the extension.
- The Premium extension also provides you the the feature to auto redirect your user to the IdP Login Page if the user is not already logged in.
4. Customer / Admin SSO
- Customer Single Sign-On (Customer SSO)
- Admin Single Sign-On (Admin SSO)
- Go to customer login page and you will see the SSO button on your frontend. Click on the button and test the SSO.
- You will be sucessfully logged in into Magento.
- Visit your admin login page and you will see the SSO button on your admin page. Click on the button to initate SSO as an admin.
- After sucessfully logged into magento as admin you will be redirect to magento backend dashboard.
Attribute Mapping / Custom Attribute Mapping(Optional). *This is Premium feature.
1.1: Attribute Mapping (Optional).
- 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.
- You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.
| 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) |
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.
- 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 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 OpenAM SAML Single Sign-On (OpenAM SSO Login) choosing OpenAM 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 OpenAM login credentials within minutes.
Additional Resources
- What is Single Sign-On (SSO) Login?
- What is SAML? How SAML SSO works?
- Magento SAML Single Sign On (SSO) Plugin.
- How to configure SSO with Azure AD
- How to configure SSO with Okta
If you are looking for anything which you cannot find, please drop us an email on magentosupport@xecurify.com
Need Help? We are right here!
