How to Setup an SAML Single Sign-On for Tenant
Table of Contents
Guide Purpose:
- This guide IS designed to:
- Show how to setup SAML SSO for Tenant
- Show how to obtain required information for the JSON Configuration from Note++
- This guide IS NOT designed to:
- Show how to understand or write an xml File
Terminologies
- SSO – Single Sign-On
- SAML – Security Assertion Markup Language
- Manifest – Xml File
- Note++ - Xml File Editor
How to Get to Tenant JSON Configuration Page
Please note that for SSO to be configured for a customer, we must receive an email from the customer with a manifest that contains the information needed for the SSO configuration.
- Click on the Administration Tab
- Select the Configuration button
- Select Companies button
- Search or scroll for the Tenant
- Select the Tenant
- Section Highlighted in BLUE is the JSON Configuration where SSO will be configured.
How to Configure SSO JSON
- Insert the SSO JSON in Configuration. Please note that there are 3 major information needed for this JSON to work accurately as highlighted in the BLUE box
- Issuer: This is the URL to our portal
- SamlUrl: This information will be obtained from the manifest
- X509Cert: this information will be obtained from the manifest
Issuer Information
The information provided here is for the portal where the SSO will be used. In the section highlighted in GREEN, we will see the URL link to our 3rd Eye portal as the issuer.
- Insert Issuer URL
SamlUrl Information
This information is obtained from the manifest. There are 2 types of SamlUrl, a redirect and a post SSO URL link. Please make sure if this is not stated in the request, we reach out to the customer to obtain the type of SamlUrl needed.
- Open the manifest using Notepad++
- If you don’t have Notepad ++, Please download it as it is free to download.
- Open the Find page by clicking Ctrl F
- Type in “Signlesignon” in the Find what field
- Click the Find next to search
- Copy the URL link for the specified type needed as highlighted in GREEN
- Insert the URL in the JSON configuration section as highlighted in GREEN
X509Cert Information
This information is obtained from the Manifest.
- Open the manifest using Notepad++
- If you don’t have Notepad ++, Please download it as it is free to download.
- Open the Find page by clicking Ctrl F
- Type in “x509cert” in the Find what field
- Click the Find next to search
- Copy the x509cert text starting after the opening-end bracket to the end of the text before the opening-close bracket as highlighted in the BLUE box
- Insert the x509cert text in the JSON configuration section as highlighted in BLUE
How to Complete Saml SSO Configuration
- Verify the SSO Configuration was inputted in the right JSON format as highlighted in the ORANGE box
- Click update
- Select close from the Success Pop up notification
- Click Save