Get Free Trial

Freshdesk SAML Single Sign-On (SSO) with Magento as SAML IdP . 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 Freshdesk 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 Freshdesk SAML Single Sign-on ( SSO ) Login into Magento 2

1. Configure Freshdesk as Service Provider

• Log into the FreshDesk Admin Portal as a System Admin. From the dashboad go to security icon from left menu bar.

• In Account section go to Security, for configuring SSO for Freshdesk users.

• In Login Settings section click on Configure Freshworks SSO, to activate the SSO login.

• In Signing in to Freshworks section click on SSO Login under the Default Login Methods.

• Now enable the SSO Login.

• Select the SAML , under Idp of your choice section.

• Click on Download Metadata, to get metadata of freshdesk.

• Enter the all details of Magento IDP, then click on Configure SSO.

  Entity ID	Enter IDP-EntityID / Issuer from the Identity Provider tab of the Magento extension.
  SAML SSO URL	Enter SAML Login URL from the Identity Provider tab of the Magento extension.
  Security Certificate	Copy the Certificate downloaded from the Identity Provider tab of the Magento extension.

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 Freshdesk 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 Freshdesk 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 Freshdesk 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)