Tutorial: Azure Active Directory integration with QuickHelp

In this tutorial, you learn how to integrate QuickHelp with Azure Active Directory (Azure AD).

Integrating QuickHelp with Azure AD provides you with the following benefits:

  • You can control in Azure AD who has access to QuickHelp
  • You can enable your users to automatically get signed-on to QuickHelp (Single Sign-On) with their Azure AD accounts
  • You can manage your accounts in one central location - the Azure portal

If you want to know more details about SaaS app integration with Azure AD, see what is application access and single sign-on with Azure Active Directory.

Prerequisites

To configure Azure AD integration with QuickHelp, you need the following items:

  • An Azure AD subscription
  • A QuickHelp single sign-on enabled subscription

Note

To test the steps in this tutorial, we do not recommend using a production environment.

To test the steps in this tutorial, you should follow these recommendations:

  • Do not use your production environment, unless it is necessary.
  • If you don't have an Azure AD trial environment, you can get a one-month trial here.

Scenario description

In this tutorial, you test Azure AD single sign-on in a test environment. The scenario outlined in this tutorial consists of two main building blocks:

  1. Adding QuickHelp from the gallery
  2. Configuring and testing Azure AD single sign-on

To configure the integration of QuickHelp into Azure AD, you need to add QuickHelp from the gallery to your list of managed SaaS apps.

To add QuickHelp from the gallery, perform the following steps:

  1. In the Azure portal, on the left navigation panel, click Azure Active Directory icon.

    Active Directory

  2. Navigate to Enterprise applications. Then go to All applications.

    Applications

  3. To add new application, click New application button on the top of dialog.

    Applications

  4. In the search box, type QuickHelp.

    Creating an Azure AD test user

  5. In the results panel, select QuickHelp, and then click Add button to add the application.

    Creating an Azure AD test user

Configuring and testing Azure AD single sign-on

In this section, you configure and test Azure AD single sign-on with QuickHelp based on a test user called "Britta Simon".

For single sign-on to work, Azure AD needs to know what the counterpart user in QuickHelp is to a user in Azure AD. In other words, a link relationship between an Azure AD user and the related user in QuickHelp needs to be established.

In QuickHelp, assign the value of the user name in Azure AD as the value of the Username to establish the link relationship.

To configure and test Azure AD single sign-on with QuickHelp, you need to complete the following building blocks:

  1. Configuring Azure AD Single Sign-On - to enable your users to use this feature.
  2. Creating an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
  3. Creating a QuickHelp test user - to have a counterpart of Britta Simon in QuickHelp that is linked to the Azure AD representation of user.
  4. Assigning the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
  5. Testing Single Sign-On - to verify whether the configuration works.

Configuring Azure AD single sign-on

In this section, you enable Azure AD single sign-on in the Azure portal and configure single sign-on in your QuickHelp application.

To configure Azure AD single sign-on with QuickHelp, perform the following steps:

  1. In the Azure portal, on the QuickHelp application integration page, click Single sign-on.

    Configure Single Sign-On

  2. On the Single sign-on dialog, select Mode as SAML-based Sign-on to enable single sign-on.

    Configure Single Sign-On

  3. On the QuickHelp Domain and URLs section, perform the following steps:

    Configure Single Sign-On

    a. In the Sign-on URL textbox, type a URL using the following pattern: https://quickhelp.com/<ROUTEURL>

    b. In the Identifier textbox, type a URL: https://auth.quickhelp.com

    Note

    The Sign-on URL value is not real. Update the value with the actual Sign-On URL. Contact your organization’s QuickHelp administrator or your BrainStorm Client Success Manager to get the value.

  4. On the SAML Signing Certificate section, click Metadata XML and then save the metadata file on your computer.

    Configure Single Sign-On

  5. Click Save button.

    Configure Single Sign-On

  6. Sign-on to your QuickHelp company site as administrator.

  7. In the menu on the top, click Admin.

    Configure Single Sign-On

  8. In the QuickHelp Admin menu, click Settings.

    Configure Single Sign-On

  9. Click Authentication Settings.

  10. On the Authentication Settings page, perform the following steps

    Configure Single Sign-On

    a. As SSO Type, select WSFederation.

    b. To upload your downloaded Azure metadata file, click Browse, navigate to the file, end then click Upload Metadata.

    c. In the Email textbox, type http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.

    d. In the First Name textbox, type http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname.

    e. In the Last Name textbox, type http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname.

    f. In the Action Bar, click Save.

Creating an Azure AD test user

The objective of this section is to create a test user in the Azure portal called Britta Simon.

Create Azure AD User

To create a test user in Azure AD, perform the following steps:

  1. In the Azure portal, on the left navigation pane, click Azure Active Directory icon.

    Creating an Azure AD test user

  2. To display the list of users, go to Users and groups and click All users.

    Creating an Azure AD test user

  3. To open the User dialog, click Add on the top of the dialog.

    Creating an Azure AD test user

  4. On the User dialog page, perform the following steps:

    Creating an Azure AD test user

    a. In the Name textbox, type BrittaSimon.

    b. In the User name textbox, type the email address of BrittaSimon.

    c. Select Show Password and write down the value of the Password.

    d. Click Create.

Creating a QuickHelp test user

The objective of this section is to create a user called Britta Simon in QuickHelp. For single sign-on to work, Azure AD needs to know what the counterpart user in QuickHelp to a user in Azure AD is. In other words, a link relationship between an Azure AD user and the related user in QuickHelp needs to be established.

QuickHelp supports just-in-time provisioning. This means, if necessary, a user account is automatically created in QuickHelp and the account is linked to the Azure AD account.

There is no action item for you in this section.

Assigning the Azure AD test user

In this section, you enable Britta Simon to use Azure single sign-on by granting access to QuickHelp.

Assign User

To assign Britta Simon to QuickHelp, perform the following steps:

  1. In the Azure portal, open the applications view, and then navigate to the directory view and go to Enterprise applications then click All applications.

    Assign User

  2. In the applications list, select QuickHelp.

    Configure Single Sign-On

  3. In the menu on the left, click Users and groups.

    Assign User

  4. Click Add button. Then select Users and groups on Add Assignment dialog.

    Assign User

  5. On Users and groups dialog, select Britta Simon in the Users list.

  6. Click Select button on Users and groups dialog.

  7. Click Assign button on Add Assignment dialog.

Testing single sign-on

The objective of this section is to test your Azure AD single sign-on configuration using the Access Panel.

When you click the QuickHelp tile in the Access Panel, you should get automatically signed-on to your QuickHelp application.

Additional resources