Tutorial: Azure Active Directory integration with Yonyx Interactive Guides

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

Integrating Yonyx Interactive Guides with Azure AD provides you with the following benefits:

  • You can control in Azure AD who has access to Yonyx Interactive Guides
  • You can enable your users to automatically get signed-on to Yonyx Interactive Guides (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 Yonyx Interactive Guides, you need the following items:

  • An Azure AD subscription
  • A Yonyx Interactive Guides 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.

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 Yonyx Interactive Guides from the gallery
  2. Configuring and testing Azure AD single sign-on

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

To add Yonyx Interactive Guides from the gallery, perform the following steps:

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

    The Azure Active Directory button

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

    The Enterprise applications blade

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

    The New application button

  4. In the search box, type Yonyx Interactive Guides, select Yonyx Interactive Guides from result panel then click Add button to add the application.

    Yonyx Interactive Guides in the results list

Configure and test Azure AD single sign-on

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

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

In Yonyx Interactive Guides, 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 Yonyx Interactive Guides, you need to complete the following building blocks:

  1. Configure Azure AD Single Sign-On - to enable your users to use this feature.
  2. Create an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
  3. Create a Yonyx Interactive Guides test user - to have a counterpart of Britta Simon in Yonyx Interactive Guides that is linked to the Azure AD representation of user.
  4. Assign the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
  5. Test single sign-on - to verify whether the configuration works.

Configure 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 Yonyx Interactive Guides application.

To configure Azure AD single sign-on with Yonyx Interactive Guides, perform the following steps:

  1. In the Azure portal, on the Yonyx Interactive Guides application integration page, click Single sign-on.

    Configure single sign-on link

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

    Single sign-on dialog box

  3. On the Yonyx Interactive Guides Domain and URLs section, perform the following steps:

    Yonyx Interactive Guides Domain and URLs single sign-on information

    a. In the Sign-on URL textbox, type a URL using the following pattern: https://<company name>.yonyx.com/y/conversation/?id=<guid number>

    b. In the Identifier textbox, type a URL using the following pattern: https://<company name>.yonyx.com

    Note

    These values are not real. Update these values with the actual Sign-On URL and Identifier. Contact Yonyx Interactive Guides Client support team to get these values.

  4. On the SAML Signing Certificate section, click Certificate(Base64) and then save the certificate file on your computer.

    The Certificate download link

  5. Click Save button.

    Configure Single Sign-On Save button

  6. On the Yonyx Interactive Guides Configuration section, click Configure Yonyx Interactive Guides to open Configure sign-on window. Copy the Sign-Out URL, SAML Entity ID, and SAML Single Sign-On Service URL from the Quick Reference section.

    Yonyx Interactive Guides Configuration

  7. To configure single sign-on on Yonyx Interactive Guides side, you need to send the downloaded Certificate(Base64), Sign-Out URL, SAML Single Sign-On Service URL SAML Entity ID to Yonyx Interactive Guides support team. They set this setting to have the SAML SSO connection set properly on both sides.

Tip

You can now read a concise version of these instructions inside the Azure portal, while you are setting up the app! After adding this app from the Active Directory > Enterprise Applications section, simply click the Single Sign-On tab and access the embedded documentation through the Configuration section at the bottom. You can read more about the embedded documentation feature here: Azure AD embedded documentation

Create an Azure AD test user

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

Create an Azure AD test 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.

    The Azure Active Directory button

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

    The "Users and groups" and "All users" links

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

    The Add button

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

    The User dialog box

    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.

Create a Yonyx Interactive Guides test user

The objective of this section is to create a user called Britta Simon in Yonyx Interactive Guides. Yonyx Interactive Guides supports just-in-time provisioning, which is by default enabled.

There is no action item for you in this section. A new user is created during an attempt to access Yonyx Interactive Guides if it doesn't exist yet.

Note

If you need to create a user manually, you need to contact the Yonyx Interactive Guides support team via support@yonyx.com.

Assign the Azure AD test user

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

Assign the user role

To assign Britta Simon to Yonyx Interactive Guides, 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 Yonyx Interactive Guides.

    The Yonyx Interactive Guides link in the Applications list

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

    The "Users and groups" link

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

    The Add Assignment pane

  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.

Test single sign-on

In this section, you test your Azure AD single sign-on configuration using the Access Panel.

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

For more information about the Access Panel, see Introduction to the Access Panel.

Additional resources