SAML Single Sign-On (SSO) in FreshDesk (SP) | Magento – FreshDesk SSO Login

Overview

Login into FreshDesk using Magento user credentials. This guide will help you integrate Magento as a SAML 2.0 Identity Provider (IdP) and FreshDesk as a Service Provider (SP) using the miniOrange Magento SAML IDP (Identity Provider) Extension. Magento SAML IDP extenstion gives you the ability to use your Magento credentials to login into FreshDesk (SP). Here we will go through a step-by-step guide to configure SSO between Server as SP (Service Provider) and Magento as IDP (Identity Provider).

Installation Steps

• Using Composer
• Manual Installation

• 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:upgrade

• 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:upgrade

Prerequisites

• Navigate to the Security icon in the sidebar and select Agents & Employees tab.
• Click on Default Login Methods.

• Enable SSO Login.

• To configure SSO choose SAML under IdP of your choice tab.

• Download the Metadata File / Copy the Assertion Consumer Service (ACS) URL and Service Provider (SP) Entity ID this will be required to configure the Identity Provider.

Steps to configure FreshDesk SAML Single Sign-on (SSO) Login into Magento 2

Configuring Magento as SAML Identity Provider (IdP):

• In the miniOrange IDP (Identity Provider) extension, go to Applications tab.

• Search for FreshDesk in the choose application searchbox and select the application.

• Enter the Application name under SP Name.

• Now, enter the SP Entity ID or Issuer and ACS URL copied earlier and save the details.

Configure FreshDesk as Service Provider:

• Navigate to the Applications tab and click on Metadata settings for the FreshDesk application

• Here, you can find the Identity Provider Metadata URL /XML Metadata or endpoints like IDP Entity ID, SAML Login URL, SAML Logout URL (Premium Feature), Certificate. You can also download the IdP Metadata XML file which will be used for FreshDesk Server configuration.

• You will now have 3 options to provide the IDP Metadata to FreshDesk server by downloading the XML Metadata, Metadata URL or providing the detials manually.
• Option 1 - Download the XML Metadata.
• Download the XML Metadata by clicking it on Download XML Metadata button.

• Navigate to your FreshDesk and upload the XML metadata file downloaded.
• Option 2 - Provide the details manually to the FreshDesk.
• Copy the metadata details according to the table below.



Entity ID	You can find this in IDP Metadata as SP-EntityID.
SAML SSO URL	You can find this in IDP Metadata as SAML Login URL.
Signing Option	You can select various signing options from the dropdown list. For now select Only Signed Assertions .
Logout URL (optional)	You can find this in IDP Metadata as SAML Logout URL.
Security Certificate	You can find this in IDP Metadata as Certificate .

• Navigate to your FreshDesk and paste the metadata details.

Attribute Mapping *(This is a Premium Feature)

• In the miniOrange Magento IDP extension, navigate to the Applications tab and click on Edit settings for the FreshDesk application.

• Click on Add Attribute button.

• Add the attribute name you want to send to your service provider and select the attribute from the dropdown menu and click on Save Button to save changes.


You have successfully configured the SAML SSO between FreshDesk as SAML SP and Magento as SAML IDP.




Related Articles



• What is SSO?
• What is SAML IDP SSO?
• Magento SAML SSO
• Magento as SAML IDP