Tutorial: Azure Active Directory integration with HeyBuddy

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

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

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

  • An Azure AD subscription
  • A HeyBuddy 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 HeyBuddy from the gallery
  2. Configuring and testing Azure AD single sign-on

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

To add HeyBuddy 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 HeyBuddy, select HeyBuddy from result panel then click Add button to add the application.

    HeyBuddy 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 HeyBuddy based on a test user called "Britta Simon".

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

To configure and test Azure AD single sign-on with HeyBuddy, 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 HeyBuddy test user - to have a counterpart of Britta Simon in HeyBuddy 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 HeyBuddy application.

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

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

    Configure single sign-on link

  2. On the Select a Single sign-on method dialog, Click Select for SAML mode to enable single sign-on.

    Configure Single Sign-On

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

    Configure Single Sign-On

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

    HeyBuddy Domain and URLs single sign-on information

    a. In the Sign on URL textbox, type a URL using the following pattern: https://api.heybuddy.com/auth/<ENTITY ID>

    b. In the Identifier (Entity ID) textbox, type a URL using the following pattern: YourCompanyInstanceofHeyBuddy

    Note

    These values are not real. Update these values with the actual Sign-On URL and Identifier (Entity ID). The Entity ID in the Sign on url is auto generated for each organization. Contact HeyBuddy Client support team to get these values.

  5. HeyBuddy application expects the SAML assertions in a specific format. Configure the following claims for this application. You can manage the values of these attributes from the User Attributes & Claims section on application integration page. On the Set up Single Sign-On with SAML page, click Edit button to open User Attributes & Claims dialog.

    image

    Note

    Please refer to this link on how to configure and setup the roles for the application.

  6. In the User Claims section on the User Attributes & Claims dialog, configure SAML token attribute as shown in the image above and perform the following steps:

    Name Source Attribute
    Roles user.assignedroles

    a. Click Add new claim to open the Manage user claims dialog.

    image

    image

    b. In the Name textbox, type the attribute name shown for that row.

    c. Leave the Namespace value blank.

    d. Select Source as Attribute.

    e. From the Source attribute list, type the attribute value shown for that row.

    f. Click Save.

  7. On the SAML Signing Certificate page, in the SAML Signing Certificate section, click the copy icon to copy App Federation Metadata Url and paste it into notepad.

    The Certificate download link

  8. To configure single sign-on on HeyBuddy side, you need to send the copied App Federation Metadata Url to HeyBuddy support team. They set this setting to have the SAML SSO connection set properly on both sides.

Creating 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.

    Create Azure AD User

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

    Creating an Azure AD test user

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

    Creating an Azure AD test user

    a. In the Name field, enter BrittaSimon.

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

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

    d. Select Create.

Creating a HeyBuddy test user

The objective of this section is to create a user called Britta Simon in HeyBuddy. HeyBuddy 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 HeyBuddy if it doesn't exist yet.

Note

If you need to create a user manually, contact HeyBuddy support team.

Assigning the Azure AD test user

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

  1. In the Azure portal, select Enterprise Applications, select All applications.

    Assign User

  2. In the applications list, select HeyBuddy.

    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. 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. In the Add Assignment dialog select the Assign button.

Testing single sign-on

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

When you click the HeyBuddy tile in the Access Panel, you should get automatically signed-on to your HeyBuddy application. For more information about the Access Panel, see Introduction to the Access Panel.

Additional resources