With Microsoft Azure AD Single Sign-on, you can allow your agents and customers to log in to the respective HappyFox panels (Agent Portal and Customer Portal) with their Azure credentials.
Note:
-
The Administrator in Azure needs to set up this integration (needs access to Active Directory / Application settings)
-
Customers are expected to login into the customer portal and agent members are expected to login into agent portal. The right URL should be shared with concerned parties.
-
The custom domain in HappyFox (if present) needs to be SSL enabled in order to work with Azure integration.
- Integration can be achieved for all azure active directory plans(including trial account)
Enabling Azure AD SSO involves:
- Configuring the HappyFox enterprise app inside your Microsoft Azure account.
- Installing the Azure AD SSO app inside HappyFox with the target URL and IdP Signature.
Configuring HappyFox enterprise app inside your Microsoft Azure:
1. Login to Microsoft Azure. Choose "Azure Active Directory" and click on "Enterprise applications".
2. Click on "New Application".
3. Navigate to "CRM" category and search for "HappyFox".
4. Select “Add" to confirm adding HappyFox. You can customize the name and icon if required.
5. After adding HappyFox, navigate back into "Enterprise applications" and click on the Name entered by you in the previous step (here "HappyFox two")
6. Now, navigate to the "Single-Sign-On" tab. For Single Sign-on Mode, choose "SAML" .
7. Under Basic SAML Configuration, the following needs to be filled:
Identifier (Entity ID): https://<account-name>.happyfox.com/saml/metadata/
Add the following in separate Reply URL fields:
https://<account-name>.happyfox.com/staff/saml/azure/callback/
https://<account-name>.happyfox.com/staff/saml/callback/
https://<account-name>.happyfox.com/saml/callback/
Sign On URL : https://<account-name>.happyfox.com/
Note: If you are using Custom SAML method from HappyFox Apps and not the in-built Azure AD SSO app, please use the below values in the Azure Server configuration
Identifier (Entity ID): https://<account-name> .happyfox.com/saml/client-metadata/
Reply URL: https://<account-name>.happyfox.com/saml/azure/callback/
https://<account-name>.happyfox.com/staff/saml/callback/
https://<account-name>.happyfox.com/saml/callback/
Sign On URL : https://<account-name>.happyfox.com/
Note: If you have setup a custom domain URL for your HappyFox account replace <account-name>.happyfox.com in the previous URLs with your custom domain.
Examples:
Sign On URL : https://xyz.happyfox.com/
Identifier : https://xyz.happyfox.com/saml/metadata/
8. Under SAML Signing Certificate, click on Edit icon. Enter the email address that needs to be notified of the setup.
9. The Base64 Certificate can be download directly as shown above or go to Edit icon >> Context menu.
10. Copy the “Login URL” from "Set Up HappyFox" to your clipboard that needs to be pasted on the HappyFox setup.
Assign User Permissions:
Azure agent/user needs to be assigned necessary permissions to the application created in Azure (here HappyFox).
To assign User permission, follow the below steps:
1. Open the Azure Portal and sign in as a Global Administrator or Co-admin.
2. Navigate to Enterprise Applications >> Your HappyFox set up name ( Here "HappyFox two") >> User and Groups >> Add User.
3. Select the user who needs to be given permission and click on Assign.
Installing the Azure AD SSO app inside HappyFox with the target URL and Certificate:
- Log in to HappyFox. Go to Apps >> Single Sign On >> Azure AD.
- Click "Install".
- Ensure SAML integration is active. Under "SAML Configuration", ensure it is "Azure".
- SSO Target URL is the URL that was copied previously (in step #10) into the clipboard.
- Open the saved certificate (copied to clipboard in step #9), copy its content into a text editor and paste it in IdP Signature and click on Save Settings.
Test the Setup in AZURE AD:
Once the details are filled on both the Azure and HappyFox front, you can test the connection.
LOGIN SCENARIOS
For Agent portal SSO - https://<account-name>.happyfox.com/staff/saml/azure/callback/
For Contact portal SSO - https://<account-name>.happyfox.com/saml/azure/callback/
Scenario 1: Agent Login:
From the HappyFox’s agent login page, when the agent clicks choose Azure SSO as the login method, he/she gets directed to the login screen shown below:
-
When an existing agent member enters his credentials, he will be directed to the agent portal.
-
When a new agent member enters his credentials, he will be added as a pending agent member.
Scenario 2: Customer Login
From HappyFox contact login page, when the contact chooses Azure SSO as the login method, he/she gets directed to Azure login screen.
-
If an existing contact enters his credentials, he/she will be directed to the self-service portal
-
If a new customer enters his credentials, a new contact account will be created and he/she will be directed to the self-service portal