Skip to content

Commit 402a3a8

Browse files
authored
Merge pull request #87504 from v-viinde/contractworksupdate
Product Backlog Item 806887: SaaS App Tutorial: ContractWorks
2 parents 57478d8 + 2356266 commit 402a3a8

File tree

1 file changed

+66
-143
lines changed

1 file changed

+66
-143
lines changed
Lines changed: 66 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tutorial: Azure Active Directory integration with ContractWorks | Microsoft Docs'
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with ContractWorks | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and ContractWorks.
44
services: active-directory
55
documentationCenter: na
@@ -9,211 +9,134 @@ ms.reviewer: barbkess
99

1010
ms.assetid: e7b269d6-3c4e-4bc4-a55f-5071d1f52591
1111
ms.service: active-directory
12+
ms.subservice: saas-app-tutorial
1213
ms.workload: identity
1314
ms.tgt_pltfrm: na
1415
ms.devlang: na
1516
ms.topic: tutorial
16-
ms.date: 01/25/2019
17+
ms.date: 09/05/2019
1718
ms.author: jeedes
1819

1920
ms.collection: M365-identity-device-management
2021
---
21-
# Tutorial: Azure Active Directory integration with ContractWorks
2222

23-
In this tutorial, you learn how to integrate ContractWorks with Azure Active Directory (Azure AD).
24-
Integrating ContractWorks with Azure AD provides you with the following benefits:
23+
# Tutorial: Azure Active Directory single sign-on (SSO) integration with ContractWorks
2524

26-
* You can control in Azure AD who has access to ContractWorks.
27-
* You can enable your users to be automatically signed-in to ContractWorks (Single Sign-On) with their Azure AD accounts.
28-
* You can manage your accounts in one central location - the Azure portal.
25+
In this tutorial, you'll learn how to integrate ContractWorks with Azure Active Directory (Azure AD). When you integrate ContractWorks with Azure AD, you can:
2926

30-
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](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis).
31-
If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/) before you begin.
27+
* Control in Azure AD who has access to ContractWorks.
28+
* Enable your users to be automatically signed-in to ContractWorks with their Azure AD accounts.
29+
* Manage your accounts in one central location - the Azure portal.
30+
31+
To learn more about SaaS app integration with Azure AD, see [What is application access and single sign-on with Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis).
3232

3333
## Prerequisites
3434

35-
To configure Azure AD integration with ContractWorks, you need the following items:
35+
To get started, you need the following items:
3636

37-
* An Azure AD subscription. If you don't have an Azure AD environment, you can get one-month trial [here](https://azure.microsoft.com/pricing/free-trial/)
38-
* ContractWorks single sign-on enabled subscription
37+
* An Azure AD subscription. If you don't have a subscription, you can get a [free account](https://azure.microsoft.com/free/).
38+
* ContractWorks single sign-on (SSO) enabled subscription.
3939

4040
## Scenario description
4141

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

4444
* ContractWorks supports **SP** and **IDP** initiated SSO
4545

4646
## Adding ContractWorks from the gallery
4747

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

50-
**To add ContractWorks from the gallery, perform the following steps:**
51-
52-
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon.
53-
54-
![The Azure Active Directory button](common/select-azuread.png)
55-
56-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
57-
58-
![The Enterprise applications blade](common/enterprise-applications.png)
59-
60-
3. To add new application, click **New application** button on the top of dialog.
61-
62-
![The New application button](common/add-new-app.png)
63-
64-
4. In the search box, type **ContractWorks**, select **ContractWorks** from result panel then click **Add** button to add the application.
65-
66-
![ContractWorks in the results list](common/search-new-app.png)
67-
68-
## Configure and test Azure AD single sign-on
69-
70-
In this section, you configure and test Azure AD single sign-on with ContractWorks based on a test user called **Britta Simon**.
71-
For single sign-on to work, a link relationship between an Azure AD user and the related user in ContractWorks needs to be established.
72-
73-
To configure and test Azure AD single sign-on with ContractWorks, you need to complete the following building blocks:
50+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
51+
1. On the left navigation pane, select the **Azure Active Directory** service.
52+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
53+
1. To add new application, select **New application**.
54+
1. In the **Add from the gallery** section, type **ContractWorks** in the search box.
55+
1. Select **ContractWorks** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
7456

75-
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
76-
2. **[Configure ContractWorks Single Sign-On](#configure-contractworks-single-sign-on)** - to configure the Single Sign-On settings on application side.
77-
3. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
78-
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
79-
5. **[Create ContractWorks test user](#create-contractworks-test-user)** - to have a counterpart of Britta Simon in ContractWorks that is linked to the Azure AD representation of user.
80-
6. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
57+
## Configure and test Azure AD single sign-on for ContractWorks
8158

82-
### Configure Azure AD single sign-on
59+
Configure and test Azure AD SSO with ContractWorks 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 ContractWorks.
8360

84-
In this section, you enable Azure AD single sign-on in the Azure portal.
61+
To configure and test Azure AD SSO with ContractWorks, complete the following building blocks:
8562

86-
To configure Azure AD single sign-on with ContractWorks, perform the following steps:
63+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
64+
1. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
65+
1. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
66+
1. **[Configure ContractWorks SSO](#configure-contractworks-sso)** - to configure the single sign-on settings on application side.
67+
1. **[Create ContractWorks test user](#create-contractworks-test-user)** - to have a counterpart of B.Simon in ContractWorks that is linked to the Azure AD representation of user.
68+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
8769

88-
1. In the [Azure portal](https://portal.azure.com/), on the **ContractWorks** application integration page, select **Single sign-on**.
70+
## Configure Azure AD SSO
8971

90-
![Configure single sign-on link](common/select-sso.png)
72+
Follow these steps to enable Azure AD SSO in the Azure portal.
9173

92-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
74+
1. In the [Azure portal](https://portal.azure.com/), on the **ContractWorks** application integration page, find the **Manage** section and select **single sign-on**.
75+
1. On the **Select a single sign-on method** page, select **SAML**.
76+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
9377

94-
![Single sign-on select mode](common/select-saml-option.png)
78+
![Edit Basic SAML Configuration](common/edit-urls.png)
9579

96-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
97-
98-
![Edit Basic SAML Configuration](common/edit-urls.png)
99-
100-
4. On the **Basic SAML Configuration** section, If you wish to configure the application in **IDP** initiated mode, perform the following step:
101-
102-
![ContractWorks Domain and URLs single sign-on information](common/idp-identifier.png)
80+
1. On the **Set up single sign-on with SAML** page, enter the values for the following fields:
10381

10482
In the **Identifier** text box, type a URL:
10583
`https://login.securedocs.com/saml/metadata`
10684

107-
5. Click **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode:
108-
109-
![image](common/both-preintegrated-signon.png)
110-
111-
In the **Sign-on URL** text box, type a URL:
112-
`https://login.securedocs.com/saml/hint`
113-
114-
6. ContractWorks 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** section on application integration page. On the **Set up Single Sign-On with SAML** page, click **Edit** button to open **User Attributes** dialog.
115-
116-
![image](common/edit-attribute.png)
117-
118-
7. In the **User Claims** section on the **User Attributes** dialog, edit the claims by using **Edit icon** or add the claims by using **Add new claim** to configure SAML token attribute as shown in the image above and perform the following steps:
119-
120-
| Name | Source Attribute|
121-
| ---------------| --------------- |
122-
| mail | user.mail |
123-
| displayName | user.displayname |
124-
125-
a. Click **Add new claim** to open the **Manage user claims** dialog.
126-
127-
![image](common/new-save-attribute.png)
128-
129-
![image](common/new-attribute-details.png)
130-
131-
b. In the **Name** textbox, type the attribute name shown for that row.
132-
133-
c. Leave the **Namespace** blank.
134-
135-
d. Select Source as **Attribute**.
136-
137-
e. From the **Source attribute** list, type the attribute value shown for that row.
138-
139-
f. Click **Ok**
140-
141-
g. Click **Save**.
142-
143-
8. On the **Set up Single Sign-On with SAML** page, In the **SAML Signing Certificate** section, click copy button to copy **App Federation Metadata Url** and save it on your computer.
85+
1. On the **Set up single sign-on with SAML** page, In the **SAML Signing Certificate** section, click copy button to copy **App Federation Metadata Url** and save it on your computer.
14486

14587
![The Certificate download link](common/copy-metadataurl.png)
14688

147-
### Configure ContractWorks Single Sign-On
148-
149-
To configure single sign-on on **ContractWorks** side, you need to send the **App Federation Metadata Url** to [ContractWorks support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
150-
151-
### Create an Azure AD test user
152-
153-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
154-
155-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
89+
### Create an Azure AD test user
15690

157-
![The "Users and groups" and "All users" links](common/users.png)
91+
In this section, you'll create a test user in the Azure portal called B.Simon.
15892

159-
2. Select **New user** at the top of the screen.
160-
161-
![New user Button](common/new-user.png)
162-
163-
3. In the User properties, perform the following steps.
164-
165-
![The User dialog box](common/user-properties.png)
166-
167-
a. In the **Name** field enter **BrittaSimon**.
168-
169-
b. In the **User name** field type **brittasimon\@yourcompanydomain.extension**
170-
For example, [email protected]
171-
172-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
173-
174-
d. Click **Create**.
93+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
94+
1. Select **New user** at the top of the screen.
95+
1. In the **User** properties, follow these steps:
96+
1. In the **Name** field, enter `B.Simon`.
97+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
98+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
99+
1. Click **Create**.
175100

176101
### Assign the Azure AD test user
177102

178-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to ContractWorks.
103+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to ContractWorks.
179104

180-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **ContractWorks**.
105+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
106+
1. In the applications list, select **ContractWorks**.
107+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
181108

182-
![Enterprise applications blade](common/enterprise-applications.png)
109+
![The "Users and groups" link](common/users-groups-blade.png)
183110

184-
2. In the applications list, select **ContractWorks**.
111+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
185112

186-
![The ContractWorks link in the Applications list](common/all-applications.png)
113+
![The Add User link](common/add-assign-user.png)
187114

188-
3. In the menu on the left, select **Users and groups**.
115+
1. In the **Users and groups** dialog, select **B.Simon** from the Users list, then click the **Select** button at the bottom of the screen.
116+
1. 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.
117+
1. In the **Add Assignment** dialog, click the **Assign** button.
189118

190-
![The "Users and groups" link](common/users-groups-blade.png)
119+
## Configure ContractWorks SSO
191120

192-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
193-
194-
![The Add Assignment pane](common/add-assign-user.png)
195-
196-
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.
197-
198-
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.
199-
200-
7. In the **Add Assignment** dialog click the **Assign** button.
121+
To configure single sign-on on **ContractWorks** side, you need to send the **App Federation Metadata Url** to [ContractWorks support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
201122

202123
### Create ContractWorks test user
203124

204-
In this section, you create a user called Britta Simon in ContractWorks. Work with [ContractWorks support team](mailto:[email protected]) to add the users in the ContractWorks platform. Users must be created and activated before you use single sign-on.
125+
In this section, you create a user called B.Simon in ContractWorks. Work with [ContractWorks support team](mailto:[email protected]) to add the users in the ContractWorks platform. Users must be created and activated before you use single sign-on.
205126

206-
### Test single sign-on
127+
## Test SSO
207128

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

210131
When you click the ContractWorks tile in the Access Panel, you should be automatically signed in to the ContractWorks for which you set up SSO. For more information about the Access Panel, see [Introduction to the Access Panel](https://docs.microsoft.com/azure/active-directory/active-directory-saas-access-panel-introduction).
211132

212-
## Additional Resources
133+
## Additional resources
134+
135+
- [ List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory ](https://docs.microsoft.com/azure/active-directory/active-directory-saas-tutorial-list)
213136

214-
- [List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-saas-tutorial-list)
137+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
215138

216-
- [What is application access and single sign-on with Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
139+
- [What is conditional access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
217140

218-
- [What is Conditional Access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
141+
- [Try ContractWorks with Azure AD](https://aad.portal.azure.com/)
219142

0 commit comments

Comments
 (0)