HappyFox

Before You Begin

Introduction

This document describes how to configure Oracle Identity Cloud Service to provide Single Sign-On (SSO) for HappyFox using SAML.

About HappyFox

HappyFox is an efficient help desk tool with a combination of both intuitive automation and self-service tools for tracking and managing help desk tickets.

After integrating HappyFox with Oracle Identity Cloud Service:

  • Users can access HappyFox using their Oracle Identity Cloud Service login credentials.
  • Users can start HappyFox using the Oracle Identity Cloud Service My Apps console.
  • Admins can assign and revoke user access to the HappyFox app using the Oracle Identity Cloud Service administration console.

What Do You Need?

  • An Oracle Identity Cloud Service account with authorization rights to manage apps and users (Identity Domain Administrator or Application Administrator).
  • A HappyFox account with authorization rights to configure federated authentication.
  • Make sure that the email ID of each user in HappyFox matches the primary email ID of the Oracle Identity Cloud Service account.

Configuring the HappyFox App in Oracle Identity Cloud Service

Use this section to register and activate the HappyFox app, and then assign users to the app.

Prerequisite Step

A dedicated domain name is required before you can register and activate the HappyFox app. You obtain that domain name from HappyFox.

The HappyFox domain name appears at the beginning of the HappyFox login URL: https://<Domain_Name>.happyfox.com/staff that you received in an email from HappyFox.

Registering and Activating the HappyFox App

  1. Access the Oracle Identity Cloud Service administration console, select Applications, and then click Add.

  2. Click App Catalog.

  3. Search for HappyFox, and then click Add.

  4. In the App Details section, enter your Domain Name, and then click Next.

    Note: This is the value that you obtained while performing the steps in the "Prerequisite Step" section.

  5. Click Download Signing Certificate.

    HappyFox expects the certificate file to have a line break after column 64. However, certificate downloaded from Oracle Identity Cloud Service doesn't have a line break after column 64.

  6. Use Linux/Unix fold -w 64 -s Certificate_filename.pem > Folded-Cert_filename.pem command to insert line break after column 64.

    Tip: Use this updated certificate file later during HappyFox configuration in the "Configuring SSO for HappyFox" section.

  7. Click Finish. Oracle Identity Cloud Service displays a confirmation message.

  8. Click Activate, and then click Activate Application. Oracle Identity Cloud Service displays a confirmation message.

Assigning Users to the HappyFox App

  1. On the HappyFox app page in Oracle Identity Cloud Service, select Users, and then click Assign. The Assign Users window appears.

  2. Select users that you want to assign to HappyFox, and then click OK. Oracle Identity Cloud Service displays a confirmation message stating that the HappyFox app is assigned to the users that you selected.

Configuring SSO for HappyFox

  1. Access HappyFox as an administrator using the URL: https://<Domain_Name>.happyfox.com/staff. The HappyFox home page appears.

  2. On the header menu, click Manage, and then click Integrations. The Manage Integrations page appears.

  3. In the External section, locate SAML Integration, and then click configure. The SAML Integration page appears.

  4. Use the following table to update the federated authentication attributes, and then click Save Settings.

    This table lists the mandatory federated authentication attributes that you must set to complete the SSO configuration.
    Attribute Value
    SAML Integration active Select Yes from the drop-down list.
    Choose SSO Provider Select Custom SAML Method from the drop-down list.
    SSO Target URL Enter the Sign-on URL/SSO Endpoint: https://<IDCS-Service-Instance>.identity.oraclecloud.com/fed/v1/idp/sso.
    IdP Signature Paste the certificate that you updated while performing the steps in the "Registering and Activating the HappyFox App" section. See the "Registering and Activating the HappyFox App" section.

Verifying the Integration

Use this section to verify that SSO works when initiated from Oracle Identity Cloud Service (IdP Initiated SSO) and HappyFox (SP initiated SSO).

Verifying Identity Provider Initiated SSO from Oracle Identity Cloud Service

  1. Access the Oracle Identity Cloud Service My Profile console using the URL: https://<IDCS-Service-Instance>.identity.oraclecloud.com/ui/v1/myconsole.

  2. Log in using credentials for a user that is assigned to the HappyFox app. Oracle Identity Cloud Service displays a shortcut to HappyFox under My Apps.

  3. Click HappyFox. The HappyFox home page appears.

  4. In the upper-right corner of the header, confirm that the user that is logged in is the same for both HappyFox and Oracle Identity Cloud Service.

    This confirms that SSO that is initiated from Oracle Identity Cloud Service works.

Verifying Service Provider Initiated SSO from HappyFox

  1. Access HappyFox using the URL: https://<Domain_Name>.happyfox.com/staff. The HappyFox login page appears.

  2. Click SAML next to the login fields. You are redirected to the Oracle Identity Cloud Service login page.

  3. Log in using credentials for a user that is assigned to the HappyFox app. The HappyFox home page appears.

  4. In the upper-right corner of the header, confirm that the user that is logged in is the same for both HappyFox and Oracle Identity Cloud Service.

    This confirms that SSO that is initiated from HappyFox works.

Troubleshooting

Use this section to locate solutions to common integration issues.

Known Issues

HappyFox displays the message, "Validation successful. Please contact your account admin to gain access to tickets."

Cause: The email attribute sent by Oracle Identity Cloud Service during SSO doesn't match any existing user in HappyFox.

Solution: Ensure that the user that you assign to the HappyFox has an account in both Oracle Identity Cloud Service and HappyFox with the same email address.

Oracle Identity Cloud Service displays the message, "You are not authorized to access the app. Contact your system administrator."

Cause 1: The SAML 2.0 integration between the Oracle Identity Cloud Service HappyFox app and HappyFox is deactivated.

Solution 1:

  • Access the Oracle Identity Cloud Service administration console, select Applications, and then select HappyFox.
  • In the App Details section, click Activate, and then click Activate Application. Oracle Identity Cloud Service displays a confirmation message.

Cause 2: The administrator revokes access for the user at the same time that the user tries to access the HappyFox app using Oracle Identity Cloud Service.

Solution 2:

  • Access the Oracle Identity Cloud Service administration console, select Applications, and then select HappyFox.
  • In the App Details section, select Users, and then click Assign to re-assign the user.

Unknown Issues

For unknown issues, contact Oracle Support:

  1. Go to https://support.oracle.com.

  2. Select Cloud Support, and then sign in with your support credentials.

  3. In the Cloud Dashboard, confirm that there are no planned outages in Oracle Identity Cloud Service, and then click Create Service Request.

  4. Select Oracle Identity Cloud Service as the service type.

  5. Complete your service request.