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 be automatically signed-in 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. If you don't have an Azure subscription, create a free account before you begin.

Prerequisites

To configure Azure AD integration with Yonyx Interactive Guides, you need the following items:

  • An Azure AD subscription. If you don't have an Azure AD environment, you can get a free account
  • Yonyx Interactive Guides single sign-on enabled subscription

Scenario description

In this tutorial, you configure and test Azure AD single sign-on in a test environment.

  • Yonyx Interactive Guides supports SP initiated SSO

  • Yonyx Interactive Guides supports Just In Time user provisioning

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 and then select the All Applications option.

    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, a link relationship between an Azure AD user and the related user in Yonyx Interactive Guides needs to be established.

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. Configure Yonyx Interactive Guides Single Sign-On - to configure the Single Sign-On settings on application side.
  3. Create an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
  4. Assign the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
  5. Create 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.
  6. 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.

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, select Single sign-on.

    Configure single sign-on link

  2. On the Select a Single sign-on method dialog, select SAML/WS-Fed mode to enable single sign-on.

    Single sign-on select mode

  3. On the Set up Single Sign-On with SAML page, click Edit icon to open Basic SAML Configuration dialog.

    Edit Basic SAML Configuration

  4. On the Basic SAML Configuration section, perform the following steps:

    Yonyx Interactive Guides Domain and URLs single sign-on information

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

    b. In the Identifier (Entity ID) text box, 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. You can also refer to the patterns shown in the Basic SAML Configuration section in the Azure portal.

  5. On the Set up Single Sign-On with SAML page, in the SAML Signing Certificate section, click Download to download the Certificate (Base64) from the given options as per your requirement and save it on your computer.

    The Certificate download link

  6. On the Set up Yonyx Interactive Guides section, copy the appropriate URL(s) as per your requirement.

    Copy configuration URLs

    a. Login URL

    b. Azure AD Identifier

    c. Logout URL

Configure Yonyx Interactive Guides Single Sign-On

To configure single sign-on on Yonyx Interactive Guides side, you need to send the downloaded Certificate (Base64) and appropriate copied URLs from Azure portal to Yonyx Interactive Guides support team. They set this setting to have the SAML SSO connection set properly on both sides.

Create an Azure AD test user

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

  1. In the Azure portal, in the left pane, select Azure Active Directory, select Users, and then select All users.

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

  2. Select New user at the top of the screen.

    New user Button

  3. In the User properties, perform the following steps.

    The User dialog box

    a. In the Name field enter BrittaSimon.

    b. In the User name field type brittasimon@yourcompanydomain.extension. For example, BrittaSimon@contoso.com

    c. Select Show password check box, and then write down the value that's displayed in the Password box.

    d. Click Create.

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.

  1. In the Azure portal, select Enterprise Applications, select All applications, then select Yonyx Interactive Guides.

    Enterprise applications blade

  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, select Users and groups.

    The "Users and groups" link

  4. Click the Add user button, then select Users and groups in the Add Assignment dialog.

    The Add Assignment pane

  5. In the Users and groups dialog select Britta Simon in the Users list, then click the Select button at the bottom of the screen.

  6. If you are expecting any role value in the SAML assertion then in the Select Role dialog select the appropriate role for the user from the list, then click the Select button at the bottom of the screen.

  7. In the Add Assignment dialog click the Assign button.

Create Yonyx Interactive Guides test user

In this section, a user called Britta Simon is created in Yonyx Interactive Guides. Yonyx Interactive Guides supports just-in-time user provisioning, which is enabled by default. There is no action item for you in this section. If a user doesn't already exist in Yonyx Interactive Guides, a new one is created after authentication.

Note

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

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 be automatically signed in to the Yonyx Interactive Guides for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.

Additional Resources