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

Overview

Login into Zendesk using Magento user credentials. This guide will help you integrate Magento as a SAML 2.0 Identity Provider (IdP) and Zendesk 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 Zendesk (SP). Here we will go through a step-by-step guide to configure SSO between Zendesk 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

• Open a new browser tab or window, Log in to your Zendesk Domain as Admin.
• Click on the Settings icon in the left pane.

• Then select Security in the Settings panel.
• Choose the Single Sign On (SSO) option and select SAML.

• Switch back to the tab / window with the IDP Metadata. Enter the information into the corresponding fields.

SAML SSO URL	Copy and paste the SAML Login URL.
Certificate Fingerprint	Follow the steps below to copy the Thumbprint of certificate: 1. Download and open the Certificate. 2. Go to Details and in the field column select Thumbprint. 3. Copy the Thumbprint that opens in the pane by pressing CTRL+C / Command+C (Right-Click wont work!). 4. Paste the Thumbprint in the Certificate Fingerprint. Make sure that there are no spaces in between the Certificate Fingerprint. Remove them manually.
Remote Logout URL	Copy and paste the SAML Logout URL.

• Click on Save button to save the Single Sign On (SSO) SAML settings.

Steps to configure Zendesk 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 Zendesk 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 Zendesk as Service Provider:

• Navigate to the Applications tab and click on Metadata settings for the Zendesk 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 Zendesk configuration.

• You will now have 3 options to provide the IDP Metadata to Zendesk 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 Zendesk and upload the XML metadata file downloaded and click on the Fetch Metadata button.
• Option 2 - Metadata URL.
• You can also copy the Metadata URL and provide it to your service provider to fetch the metadata.

• Option 3 - Provide the details manually to the Zendesk.
• Copy the metadata details according to the table below.



IDP-EntityID / Issuer	IDP-EntityID / Issuer
Single Sign On URL	SAML Login URL / Passive Login URL
SAML X509 Certificate	Certificate

• Navigate to your Zendesk 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 Zendesk 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 Zendesk 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