SAML Single Sign-On (SSO) in ASP.NET (SP) | Magento – ASP.NET SSO Login

Get Free Trial

ASP.NET SAML Single Sign-On (SSO) with Magento as SAML IdP . Magento SAML IdP extension gives you the ability to use your Magento credentials to login into ASP.NET (SP). Here we will go through a step-by-step guide to configure SSO between ASP.NET as SP (Service Provider) and Magento as IDP (Identity Provider).

Pre-requisites: Download and Installation

Installation using Composer:

• Purchase the miniOrange SAML IDP 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 SAML IDP Single Sign-On extension.
• Unzip all contents of the zip inside the MiniOrange/IDPSaml directory.

{Root Directory of Magento} app code MiniOrange IDPSaml

• 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 ASP.NET SAML Single Sign-on ( SSO ) Login into Magento 2

1. Configure ASP.NET as Service Provider

1.1: Share SAML Metadata with Magento

When you are configuring ASP.NET as SAML SP, follow these steps:

• In the miniOrange SAML IDP extension, navigate to the "IDP Metadata" tab to find Metadata URL, or "IDP Entity ID/Issuer," "SAML Login URL," and "Certificate" fields (Optional). You can also Download XML Metadata file to configure ASP.NET as SP and keep it handy.

• Now, got to the ASP.NET and click on Add New IDP to configure ASP.NET Single Sign-On (SSO) with Magento.

• Under Service Provider Settings tab, you can either copy-paste the metadata URL on your IDP side or download the SP metadata as an XML file. Additionally, you have the choice to manually copy and paste Base URL, SP Entity ID, and ACS URL.
• Share SAML metadata with your identity provider.

1.2: Import Magento SAML metadata

• Select Custom IDP from the list of identity providers shown below.

There are two ways detailed below with which you can configure your SAML identity provider metadata in the module.

A] Upload metadata using the Upload IDP Metadata button:

• If your identity provider has provided you with the metadata URL or metadata file (.xml format only), then you can simply configure the identity provider metadata in the module using the Upload IDP Metadata option.
• You may refer to the screenshot below:

• You can choose any one of the options according to the metadata format you have available.

B] Configure the identity provider metadata manually:

• After configuring your identity provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and SAML X509 Certificate fields respectively.
• Click Save to save your IDP details.

2. Configure Magento as Identity Provider

• In the miniOrage SAML Identity Provider extension, go to Service Provider settings tab of the extension.
• Provide the required settings (i.e. SP Entity ID/Issuer, ACS URL) find to your Service Provider ASP.NET and click on Save button to save your configuration.


Note: The Relaystate URL is mandatory if you want to use Identity Provider (IDP)/Magento initiated flow.

3. Attribute Mapping

• In the Magento IDP extension, navigate to the Attribute Mapping tab.
• In the User Attributes section, enter the following information and click on Save .
• You can also add more attributes by clicking on + sign to add attributes.

Name	User Meta Data
username	user_login
displayName	display_name
email	user_email

4. SSO Testing

• Open a new browser or private incognito window and enter your ASP.NET URL, which will redirect you to the Magento login screen.
• Enter your Magento credentials and click the log in button.
• If you are redirected to your ASP.NET start page and successfully logged in, your configuration is correct.

Additional Resources

• What is Single Sign-On (SSO)?
• What is SAML?
• Magento SAML Single Sign-On (SSO)
• Magento OAuth Client Single Sign-On (SSO)
• Frequently Asked Questions (FAQs)