Tutorial: Azure Active Directory integration with GoodPractice Toolkit
In this tutorial, you learn how to integrate GoodPractice Toolkit with Azure Active Directory (Azure AD). Integrating GoodPractice Toolkit with Azure AD provides you with the following benefits:
- You can control in Azure AD who has access to GoodPractice Toolkit.
- You can enable your users to be automatically signed-in to GoodPractice Toolkit (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.
To configure Azure AD integration with GoodPractice Toolkit, you need the following items:
- An Azure AD subscription. If you don't have an Azure AD environment, you can get one-month trial here
- GoodPractice Toolkit single sign-on enabled subscription
In this tutorial, you configure and test Azure AD single sign-on in a test environment.
- GoodPractice Toolkit supports SP initiated SSO
- GoodPractice Toolkit supports Just In Time user provisioning
Adding GoodPractice Toolkit from the gallery
To configure the integration of GoodPractice Toolkit into Azure AD, you need to add GoodPractice Toolkit from the gallery to your list of managed SaaS apps.
To add GoodPractice Toolkit from the gallery, perform the following steps:
In the Azure portal, on the left navigation panel, click Azure Active Directory icon.
Navigate to Enterprise Applications and then select the All Applications option.
To add new application, click New application button on the top of dialog.
In the search box, type GoodPractice Toolkit, select GoodPractice Toolkit from result panel then click Add button to add the application.
Configure and test Azure AD single sign-on
In this section, you configure and test Azure AD single sign-on with GoodPractice Toolkit 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 GoodPractice Toolkit needs to be established.
To configure and test Azure AD single sign-on with GoodPractice Toolkit, you need to complete the following building blocks:
- Configure Azure AD Single Sign-On - to enable your users to use this feature.
- Configure GoodPractice Toolkit Single Sign-On - to configure the Single Sign-On settings on application side.
- Create an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
- Create GoodPractice Toolkit test user - to have a counterpart of Britta Simon in GoodPractice Toolkit that is linked to the Azure AD representation of user.
- Assign the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
- 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 GoodPractice Toolkit, perform the following steps:
In the Azure portal, on the GoodPractice Toolkit application integration page, select Single sign-on.
On the Select a Single sign-on method dialog, select SAML/WS-Fed mode to enable single sign-on.
On the Set up Single Sign-On with SAML page, click Edit icon to open Basic SAML Configuration dialog.
On the Basic SAML Configuration section, perform the following steps:
In the Sign-on URL text box, type a URL using the following pattern:
The Sign-on URL value is not real. Update the value with the actual Sign-On URL. Contact GoodPractice Toolkit Client support team to get the value.
On the Set up Single Sign-On with SAML page, in the SAML Signing Certificate section, click Download to download the Federation Metadata XML from the given options as per your requirement and save it on your computer.
On the Set up GoodPractice Toolkit section, copy the appropriate URL(s) as per your requirement.
a. Login URL
b. Azure Ad Identifier
c. Logout URL
Configure GoodPractice Toolkit Single Sign-On
To configure single sign-on on GoodPractice Toolkit side, you need to send the downloaded Federation Metadata XML and appropriate copied URLs from Azure portal to GoodPractice Toolkit 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.
In the Azure portal, in the left pane, select Azure Active Directory, select Users, and then select All users.
Select New user at the top of the screen.
In the User properties, perform the following steps.
a. In the Name field enter BrittaSimon.
b. In the User name field type email@example.com
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 GoodPractice Toolkit.
In the Azure portal, select Enterprise Applications, select All applications, then select GoodPractice Toolkit.
In the applications list, select GoodPractice Toolkit.
In the menu on the left, select Users and groups.
Click the Add user button, then select Users and groups in the Add Assignment dialog.
In the Users and groups dialog select Britta Simon in the Users list, then click the Select button at the bottom of the screen.
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.
In the Add Assignment dialog click the Assign button.
Create GoodPractice Toolkit test user
In this section, a user called Britta Simon is created in GoodPractice Toolkit. GoodPractice Toolkit supports just-in-time provisioning, which is enabled by default. There is no action item for you in this section. If a user doesn't already exist in GoodPractice Toolkit, a new one is created when you attempt to access GoodPractice Toolkit.
Test single sign-on
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
When you click the GoodPractice Toolkit tile in the Access Panel, you should be automatically signed in to the GoodPractice Toolkit for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.