Tutorial: Azure Active Directory integration with Reward Gateway

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

Integrating Reward Gateway with Azure AD provides you with the following benefits:

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

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

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

To add Reward Gateway 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 Reward Gateway.

    Creating an Azure AD test user

  5. In the results panel, select Reward Gateway, 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 Reward Gateway based on a test user called "Britta Simon".

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

In Reward Gateway, 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 Reward Gateway, 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 Reward Gateway test user - to have a counterpart of Britta Simon in Reward Gateway 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 Reward Gateway application.

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

  1. In the Azure portal, on the Reward Gateway 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 Reward Gateway Domain and URLs section, perform the following steps:

    Configure Single Sign-On

    a. In the Identifier textbox, type a URL using the following pattern:

    https://<companyname>.rewardgateway.com
    https://<companyname>.rewardgateway.co.uk/
    https://<companyname>.rewardgateway.co.nz/
    https://<companyname>.rewardgateway.com.au/

    b. In the Reply URL textbox, type a URL using the following pattern:

    https://<companyname>.rewardgateway.com/Authentication/EndLogin?idp=<Unique Id>
    https://<companyname>.rewardgateway.co.uk/Authentication/EndLogin?idp=<Unique Id>
    https://<companyname>.rewardgateway.co.nz/Authentication/EndLogin?idp=<Unique Id>
    https://<companyname>.rewardgateway.com.au/Authentication/EndLogin?idp=<Unique Id>

    Note

    These values are not real. Update these values with the actual Identifier and Reply URL. To get these values start setting up an Integration on the Reward Manager Portal. Details can be found on http://success.rewardgateway.com/it-implementation/293968-how-to-configure-a-sso-integration

  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. To configure single sign-on on Reward Gateway side, start setting up an Integration on the Reward Manager Portal. Use the downloaded metadata to obtain your Signing Certificate and upload that during the configuration. Details can be found on http://success.rewardgateway.com/it-implementation/293968-how-to-configure-a-sso-integration

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

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 Reward Gateway test user

In this section, you create a user called Britta Simon in Reward Gateway. Work with Reward Gateway support team to add the users in the Reward Gateway platform.

Assigning the Azure AD test user

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

Assign User

To assign Britta Simon to Reward Gateway, 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 Reward Gateway.

    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

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

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

Additional resources