Search Results :

×

Magento Keycloak SAML SSO (Single Sign-On) | Magento Keycloak SSO | Login using Keycloak in Magento

Magento Keycloak SAML SSO (Single Sign-On) | Magento Keycloak SSO | Login using Keycloak in Magento


Get Free Trial

Keycloak Single Sign-On (SSO) login for Magento [Magento Keycloak SSO] 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 Keycloak to securely authenticate and login users to the Magento site using Keycloak. Our Magento Single Sign-On (SSO) solution helps to secure Magento sites behind the SSO login so that users are authenticated using their Keycloak login credentials. Seamless support for advanced SSO features like Attribute / Custom Mapping, Role Mapping etc.

Here we will go through a guide to configure SAML Single Sign-On SSO login between Magento site and Keycloak by considering Keycloak as IdP (Identity Provider) and Magento as SP (Service Provider). Our SSO plugin provides Unlimited user authentications from Keycloak. To know more about other features we provide in you Magento Keycloak 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 saml-sp-single-sign-on:{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 zip from here.
  • Unzip all contents of the zip inside the MiniOrange/SP directory.
  • {Root Directory of Magento} app code MiniOrange SP
  • Run the following commands on command prompt to enable the extension
  • 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]

 Tested with 2.4.5

Steps to configure Keycloak SAML Single Sign-On (SSO) Login into Magento SAML SP


1. Setup Keycloak as IDP (Version 18 and below)

Follow the steps below to configure Keycloak (Version 18 and below) as IdP for Magento

miniorange img Configure Keycloak 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 Keycloak as the Identity Provider.
  • Magento Keycloak SSO - Magento SSO - Keycloak SSO Login
  • Select the realm you want to use in the Keycloak Admin console.
  • To create a new client/application, go to the left menu and select Clients, then Create.
  • Creating an APP - Keycloak SAML Single Sign-On(SSO) for Magento - Magento Keycloak SSO Login
  • From the "Service Provider Metadata" Tab, select SP-EntityID / Issuer as the Client ID and SAML as the Client Protocol.
  • Add Client - Keycloak SAML Single Sign-On(SSO) for Magento - Magento Keycloak SSO Login
  • Now click on Save.
  • Configure Keycloak by providing the required details:
  • Client ID The SP-EntityID / Issuer from Service Provider Metadata
    NameProvide a name for this client (Eg. Joomla)
    Description (optional)Provide a description
    EnabledON
    Consent RequiredOFF
    Client ProtocolSAML
    Include AuthnStatementNO
    Sign DocumentsNO
    Optimize Redirect signing key lookupOFF
    Sign AssertionsNO
    Signature AlgorithmRSA_SHA256
    Encrypt AssertionOFF
    Client Signature RequiredOFF
    Client Signature RequiredEXCLUSIVE
    Force Name ID FormatNO
    Name ID FormatEmail
    Root URLLeave empty or Base URL of Service Provider
    Valid Redirect URIsThe ACS (Assertion Consumer Service) URL from Service Provider Metadata
    Magento Keycloak SSO - Settings - Keycloak SAML Single Sign-On(SSO) for Magento - Magento Keycloak SSO Login Keycloak Login - Settings - Keycloak SAML Single Sign-On(SSO) for Magento - Keycloak Magento SSO Login
  • In Keycloak, Under Fine Grain SAML Endpoint Configuration, Enter the following details:
  • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
    Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab
    Login SAML Endpoint Configuration - Magento Keycloak SSO - Keycloak Magento SSO Login
  • Click on Save.

miniorange img  Add Mappers

  • Go to the Mappers tab and press the Add Builtin button in Keycloak.
  • Keycloak Login - Mappers Tab - Magento Keycloak SSO - Keycloak Magento SSO Login
  • Enable the checkboxes of X500 givenName, X500 surname and X500 email attributes.
  • Keycloak Login - Add built-in protocol mapper - Keycloak SAML Single Sign-On(SSO) for Magento - Magento Keycloak SSO
  • Click on Add Selected button. You will see the mappings that are added below in Keycloak .
  • Keycloak Login - Add Selected - Magento Keycloak SSO - Keycloak Magento SSO Login

miniorange img Download setup file

  • Navigate to Realm Settings, in Keycloak click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
  • JBoss Keycloak SSO-7 - Keycloak SAML Single Sign-On(SSO) for Magento - Keycloak Magento SSO Login
  • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
  • You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into Magento Site.

1. Setup Keycloak as IDP (Version 19 and above)

Follow the steps below to configure Keycloak (Version 19 and above) as IdP for Magento

miniorange img Configure Keycloak 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 Keycloak as the Identity Provider.
  • Configure Keycloak as IDP - Magento SSO - Keycloak SSO Login
  • In your Keycloak Admin console, select the realm that you want to use.
  • Click on Clients from the left menu and then click on Create Client button to create a new client/application in Keycloak.
  • Magento Keycloak SSO Creating an APP
  • Select SAML as Client type, Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab,Enter Name of your application and enter Description.
  • Magento Keycloak SSO Add Client
  • Now click on Save.
  • Configure Keycloak by providing the required details:
  • Client ID The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab
    Name Provide a name for this client
    Description Provide a description
    Client Signature Required OFF
    Force POST Binding OFF
    Force Name ID Format OFF
    Name ID Format Email
    Root URL Leave empty or Provide Base URL from Service Provider Metadata tab
    Valid Redirect URIs The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
    Magento Keycloak SSO Keycloak Login - Settings Magento Keycloak SSO Keycloak Login - Settings Magento Keycloak SSO Keycloak Login - Settings
  • Now click on Save.
  • In Advanced tab,under Fine Grain SAML Endpoint Configuration, Enter the following details:
  • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
    Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab
    Magento Keycloak Login | Login SAML Endpoint Configuration
  • Click on Save.

miniorange img  Add Mappers

  • In Client scopes tab,click on your application.
  • Magento Keycloak SSO | click on application
  • Click on Add predefined mapper in Keycloak. Magento Keycloak SSO | Add predefined mapper
  • Select the checkboxes of X500 givenName, X500 surname and X500 email attributes in Keycloak.
  • Magento Keycloak SSO | select checkboxes
  • Click on Add button.
  • You will see the mappings that are added below in Keycloak.
  • Magento Keycloak | mappings

miniorange img  Download setup file

  • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tabin Keycloak.
  • Magento Keycloak configure settings Magento Keycloak
  • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
  • You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into 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.
  • Azure AD Magento SSO - Azure Single Sign-On(SSO) Login in Magento - federation metadata
  • To check if your Magento as SP is configured correctly, click the Test Configuration button.
  • Azure AD Magento SSO - Azure Single Sign-On(SSO) Login in Magento - federation metadata

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)
  • Magento 2 SSO Azure AD Single Sign-on (SSO) Admin Customer SSO
  • If you want to initate SSO from any page you can also use the SSO link provided in the extension.
  • Magento SSO using SSO link Magento 2 SSO Azure AD
  • 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.
  • Magento 2 OAuth auto redirect to idp

4. Customer / 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.
  • Magento 2 OAuth SSO customer SSO
  • You will be sucessfully logged in into Magento.
  • magento SSO magento 2 OAuth client SSO Admin SSO

  • 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.
  • Magento 2 Admin SSO login button
  • After sucessfully logged into magento as admin you will be redirect to magento backend dashboard.
  • Magento 2 Admin SSO admin 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.
  • Azure AD Magento SSO - Azure Single Sign-On(SSO) Login in Magento - attribute mapping
    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.

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.
  • Magento 2 SAML SSO custom attribute mapping

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.
  • Azure AD Magento SSO - Azure Single Sign-On(SSO) Login in Magento - role mapping

In this Guide, you have successfully configured Keycloak SAML Single Sign-On (Keycloak SSO Login) choosing Keycloak 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 Keycloak login credentials within minutes.


Additional Resources


Why Our Customers choose miniOrange Magento Single Sign-On (SSO) Solutions?


24/7 Support

We offer 24/7 support for all Magento solutions. We ensure high quality support to meet your needs.

Sign Up

Customer Reviews

See for yourself what satisfied customers have to say about our reliable Magento solutions.

Reviews

Extensive Setup Guides

Easy and precise step-by-step instructions and videos to help you configure within minutes.

Watch Demo


We offer Secure Identity Solutions for Single Sign-On, Two Factor Authentication, Provisioning, and much more. Please contact us at

 +1 978 658 9387 (US) | +91 97178 45846 (India)   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