Tutorial: Azure Active Directory single sign-on (SSO) integration with Envoy

In this tutorial, you'll learn how to integrate Envoy with Azure Active Directory (Azure AD). When you integrate Envoy with Azure AD, you can:

  • Control in Azure AD who has access to Envoy.
  • Enable your users to be automatically signed-in to Envoy with their Azure AD accounts.
  • Manage your accounts in one central location - the Azure portal.

To learn more about SaaS app integration with Azure AD, see What is application access and single sign-on with Azure Active Directory.

Prerequisites

To get started, you need the following items:

  • An Azure AD subscription. If you don't have a subscription, you can get a free account.
  • Envoy single sign-on (SSO) enabled subscription.

Scenario description

In this tutorial, you configure and test Azure AD SSO in a test environment.

  • Envoy supports SP initiated SSO

  • Envoy supports Just In Time user provisioning

Note

Identifier of this application is a fixed string value so only one instance can be configured in one tenant.

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

  1. Sign in to the Azure portal using either a work or school account, or a personal Microsoft account.
  2. On the left navigation pane, select the Azure Active Directory service.
  3. Navigate to Enterprise Applications and then select All Applications.
  4. To add new application, select New application.
  5. In the Add from the gallery section, type Envoy in the search box.
  6. Select Envoy from results panel and then add the app. Wait a few seconds while the app is added to your tenant.

Configure and test Azure AD single sign-on for Envoy

Configure and test Azure AD SSO with Envoy using a test user called B.Simon. For SSO to work, you need to establish a link relationship between an Azure AD user and the related user in Envoy.

To configure and test Azure AD SSO with Envoy, complete the following building blocks:

  1. Configure Azure AD SSO - to enable your users to use this feature.
    1. Create an Azure AD test user - to test Azure AD single sign-on with B.Simon.
    2. Assign the Azure AD test user - to enable B.Simon to use Azure AD single sign-on.
  2. Configure Envoy SSO - to configure the single sign-on settings on application side.
    1. Create Envoy test user - to have a counterpart of B.Simon in Envoy that is linked to the Azure AD representation of user.
  3. Test SSO - to verify whether the configuration works.

Configure Azure AD SSO

Follow these steps to enable Azure AD SSO in the Azure portal.

  1. In the Azure portal, on the Envoy application integration page, find the Manage section and select single sign-on.

  2. On the Select a single sign-on method page, select SAML.

  3. On the Set up single sign-on with SAML page, click the edit/pen icon for Basic SAML Configuration to edit the settings.

    Edit Basic SAML Configuration

  4. On the Basic SAML Configuration section, enter the values for the following fields:

    In the Sign-on URL text box, type a URL using the following pattern: https://app.envoy.com/a/saml/auth/<company-ID-from-Envoy>

    Note

    The value is not real. Update the value with the actual Sign-On URL. Contact Envoy Client support team to get the value. You can also refer to the patterns shown in the Basic SAML Configuration section in the Azure portal.

  5. In the SAML Signing Certificate section, click Edit button to open SAML Signing Certificate dialog.

    Edit SAML Signing Certificate

  6. In the SAML Signing Certificate section, copy the Thumbprint Value and save it on your computer.

    Copy Thumbprint value

  7. On the Set up Envoy section, copy the appropriate URL(s) based on your requirement.

    Copy configuration URLs

Create an Azure AD test user

In this section, you'll create a test user in the Azure portal called B.Simon.

  1. From the left pane in the Azure portal, select Azure Active Directory, select Users, and then select All users.
  2. Select New user at the top of the screen.
  3. In the User properties, follow these steps:
    1. In the Name field, enter B.Simon.
    2. In the User name field, enter the username@companydomain.extension. For example, B.Simon@contoso.com.
    3. Select the Show password check box, and then write down the value that's displayed in the Password box.
    4. Click Create.

Assign the Azure AD test user

In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Envoy.

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

  2. In the applications list, select Envoy.

  3. In the app's overview page, find the Manage section and select Users and groups.

    The "Users and groups" link

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

    The Add User link

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

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

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

Configure Envoy SSO

  1. To automate the configuration within Envoy, you need to install My Apps Secure Sign-in browser extension by clicking Install the extension.

    My apps extension

  2. After adding extension to the browser, click on Setup Envoy will direct you to the Envoy application. From there, provide the admin credentials to sign into Envoy. The browser extension will automatically configure the application for you and automate steps 3-7.

    Setup configuration

  3. If you want to setup Envoy manually, open a new web browser window and sign into your Envoy company site as an administrator and perform the following steps:

  4. In the toolbar on the top, click Settings.

    Envoy

  5. Click Company.

    Company

  6. Click SAML.

    SAML

  7. In the SAML Authentication configuration section, perform the following steps:

    SAML authentication

    Note

    The value for the HQ location ID is auto generated by the application.

    a. In Fingerprint textbox, paste the Thumbprint value of certificate, which you have copied from Azure portal.

    b. Paste Login URL value, which you have copied form the Azure portal into the IDENTITY PROVIDER HTTP SAML URL textbox.

    c. Click Save changes.

Create Envoy test user

In this section, a user called Britta Simon is created in Envoy. Envoy 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 Envoy, a new one is created after authentication.

Test SSO

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

When you click the Envoy tile in the Access Panel, you should be automatically signed in to the Envoy for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.

Additional resources