Skip to content

Commit be9322a

Browse files
authored
Merge pull request #99798 from itechedit/harness-provisioning-tutorial
edit pass: harness-provisioning-tutorial
2 parents e9a1bf4 + 1ec6bf9 commit be9322a

File tree

1 file changed

+70
-62
lines changed

1 file changed

+70
-62
lines changed

articles/active-directory/saas-apps/harness-provisioning-tutorial.md

Lines changed: 70 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Tutorial: Configure Harness for automatic user provisioning with Azure Active Directory | Microsoft Docs'
3-
description: Learn how to configure Azure Active Directory to automatically provision and de-provision user accounts to Harness.
3+
description: Learn how to configure Azure Active Directory to automatically provision and deprovision user accounts to Harness.
44
services: active-directory
55
documentationcenter: ''
66
author: zchia
@@ -20,151 +20,159 @@ ms.author: Zhchia
2020

2121
# Tutorial: Configure Harness for automatic user provisioning
2222

23-
The objective of this tutorial is to demonstrate the steps to be performed in Harness and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and de-provision users and/or groups to Harness.
23+
In this article, you learn how to configure Azure Active Directory (Azure AD) to automatically provision and deprovision users or groups to Harness.
2424

2525
> [!NOTE]
26-
> This tutorial describes a connector built on top of the Azure AD User Provisioning Service. For important details on what this service does, how it works, and frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../manage-apps/user-provisioning.md).
26+
> This article describes a connector that's built on top of the Azure AD user provisioning service. For important information about this service and answers to frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../manage-apps/user-provisioning.md).
2727
>
28-
> This connector is currently in Public Preview. For more information on the general Microsoft Azure terms of use for Preview features, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
28+
> This connector is currently in preview. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2929
3030
## Prerequisites
3131

32-
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
32+
The scenario outlined in this article assumes that you already have the following prerequisites:
3333

3434
* An Azure AD tenant
3535
* [A Harness tenant](https://harness.io/pricing/)
36-
* A user account in Harness with Admin permissions.
36+
* A user account in Harness with *Admin* permissions
3737

38-
## Assigning users to Harness
38+
## Assign users to Harness
3939

40-
Azure Active Directory uses a concept called *assignments* to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users and/or groups that have been assigned to an application in Azure AD are synchronized.
40+
Azure Active Directory uses a concept called *assignments* to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users or groups that have been assigned to an application in Azure AD are synchronized.
4141

42-
Before configuring and enabling automatic user provisioning, you should decide which users and/or groups in Azure AD need access to Harness. Once decided, you can assign these users and/or groups to Harness by following the instructions here:
43-
* [Assign a user or group to an enterprise app](../manage-apps/assign-user-or-group-access-portal.md)
42+
Before you configure and enable automatic user provisioning, decide which users or groups in Azure AD need access to Harness. You can then assign these users or groups to Harness by following the instructions in [Assign a user or group to an enterprise app](../manage-apps/assign-user-or-group-access-portal.md).
4443

4544
## Important tips for assigning users to Harness
4645

47-
* It is recommended that a single Azure AD user is assigned to Harness to test the automatic user provisioning configuration. Additional users and/or groups may be assigned later.
46+
* We recommended that you assign a single Azure AD user to Harness to test the automatic user provisioning configuration. Additional users or groups can be assigned later.
4847

49-
* When assigning a user to Harness, you must select any valid application-specific role (if available) in the assignment dialog. Users with the **Default Access** role are excluded from provisioning.
48+
* When you assign a user to Harness, you must select any valid application-specific role (if available) in the **Assignment** dialog box. Users with the *Default Access* role are excluded from provisioning.
5049

5150
## Set up Harness for provisioning
5251

53-
1. Sign in to your [Harness Admin Console](https://app.harness.io/#/login). Navigate to **Continuous Security > Access Management**.
52+
1. Sign in to your [Harness Admin Console](https://app.harness.io/#/login), and then go to **Continuous Security** > **Access Management**.
5453

5554
![Harness Admin Console](media/harness-provisioning-tutorial/admin.png)
5655

57-
2. Click on **API Keys**.
56+
1. Select **API Keys**.
5857

59-
![Harness Add SCIM](media/harness-provisioning-tutorial/apikeys.png)
58+
![Harness API Keys link](media/harness-provisioning-tutorial/apikeys.png)
6059

61-
3. Click on **Add New Key**. In the **Add Api Key** dialog box, provide a **Name** and select an option from **Permissions Inherited from** dropdown menu. Click on **Submit** button.
60+
1. Select **Add API Key**.
6261

63-
![Harness Add New Key](media/harness-provisioning-tutorial/addkey.png)
62+
![Harness Add API Key link](media/harness-provisioning-tutorial/addkey.png)
6463

65-
![Harness Add New Key dialog](media/harness-provisioning-tutorial/title.png)
64+
1. In the **Add Api Key** pane, do the following:
6665

67-
3. Copy the **Key**. This value will be entered in the Secret Token field in the Provisioning tab of your Harness application in the Azure portal.
66+
![Harness Add Api Key pane](media/harness-provisioning-tutorial/title.png)
67+
68+
a. In the **Name** box, provide a name for the key.
69+
b. In the **Permissions Inherited from** drop-down list, select an option.
70+
71+
1. Select **Submit**.
72+
73+
1. Copy the **Key** for later use in this tutorial.
6874

6975
![Harness Create Token](media/harness-provisioning-tutorial/token.png)
7076

7177
## Add Harness from the gallery
7278

73-
Before configuring Harness for automatic user provisioning with Azure AD, you need to add Harness from the Azure AD application gallery to your list of managed SaaS applications.
74-
75-
**To add Harness from the Azure AD application gallery, perform the following steps:**
79+
Before you configure Harness for automatic user provisioning with Azure AD, you need to add Harness from the Azure AD application gallery to your list of managed SaaS applications.
7680

77-
1. In the **[Azure portal](https://portal.azure.com)**, in the left navigation panel, select **Azure Active Directory**.
81+
1. In the [Azure portal](https://portal.azure.com), in the left pane, select **Azure Active Directory**.
7882

79-
![The Azure Active Directory button](common/select-azuread.png)
83+
![The "Azure Active Directory" button](common/select-azuread.png)
8084

81-
2. Go to **Enterprise applications**, and then select **All applications**.
85+
1. Select **Enterprise applications** > **All applications**.
8286

83-
![The Enterprise applications blade](common/enterprise-applications.png)
87+
![The "All applications" link](common/enterprise-applications.png)
8488

85-
3. To add a new application, select the **New application** button at the top of the pane.
89+
1. To add a new application, select the **New application** button at the top of the pane.
8690

87-
![The New application button](common/add-new-app.png)
91+
![The "New application" button](common/add-new-app.png)
8892

89-
4. In the search box, enter **Harness**, select **Harness** in the results panel, and then click the **Add** button to add the application.
93+
1. In the search box, enter **Harness**, select **Harness** in the results list, and then select the **Add** button to add the application.
9094

9195
![Harness in the results list](common/search-new-app.png)
9296

93-
## Configuring automatic user provisioning to Harness
97+
## Configure automatic user provisioning to Harness
9498

95-
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Harness based on user and/or group assignments in Azure AD.
99+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users or groups in Harness based on user or group assignments in Azure AD.
96100

97101
> [!TIP]
98-
> You may also choose to enable SAML-based single sign-on for Harness by following the instructions provided in the [Harness Single sign-on tutorial](https://docs.microsoft.com/azure/active-directory/saas-apps/harness-tutorial). Single sign-on can be configured independently of automatic user provisioning, although these two features complement each other
102+
> You may also choose to enable SAML-based single sign-on for Harness by following the instructions in the [Harness single sign-on tutorial](https://docs.microsoft.com/azure/active-directory/saas-apps/harness-tutorial). You can configure single sign-on independent of automatic user provisioning, although these two features complement each other.
99103
100104
> [!NOTE]
101-
> To learn more about Harness' SCIM endpoint, refer [this](https://docs.harness.io/article/smloyragsm-api-keys)
105+
> To learn more about the Harness SCIM endpoint, see the Harness [API Keys](https://docs.harness.io/article/smloyragsm-api-keys) article.
102106
103-
### To configure automatic user provisioning for Harness in Azure AD:
107+
To configure automatic user provisioning for Harness in Azure AD, do the following:
104108

105-
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
109+
1. In the [Azure portal](https://portal.azure.com), select **Enterprise Applications** > **All applications**.
106110

107111
![Enterprise applications blade](common/enterprise-applications.png)
108112

109-
2. In the applications list, select **Harness**.
113+
1. In the applications list, select **Harness**.
110114

111-
![The Harness link in the Applications list](common/all-applications.png)
115+
![The Harness link in the applications list](common/all-applications.png)
112116

113-
3. Select the **Provisioning** tab.
117+
1. Select **Provisioning**.
114118

115-
![Provisioning tab](common/provisioning.png)
119+
![The Provisioning button](common/provisioning.png)
116120

117-
4. Set the **Provisioning Mode** to **Automatic**.
121+
1. In the **Provisioning Mode** drop-down list, select **Automatic**.
118122

119-
![Provisioning tab](common/provisioning-automatic.png)
123+
![The "Provisioning Mode" drop-down list](common/provisioning-automatic.png)
120124

121-
5. Under the **Admin Credentials** section, input `https://app.harness.io/gateway/api/scim/account/XCPzWkCIQ46ypIu2DeT7yw` in **Tenant URL**. Input the **SCIM Authentication Token** value retrieved earlier in **Secret Token**. Click **Test Connection** to ensure Azure AD can connect to Harness. If the connection fails, ensure your Harness account has Admin permissions and try again.
125+
1. Under **Admin Credentials**, do the following:
122126

123127
![Tenant URL + Token](common/provisioning-testconnection-tenanturltoken.png)
128+
129+
a. In the **Tenant URL** box, enter **`https://app.harness.io/gateway/api/scim/account/XCPzWkCIQ46ypIu2DeT7yw`**.
130+
b. In the **Secret Token** box, enter the SCIM Authentication Token value that you saved in step 6 of the "Set up Harness for provisioning" section.
131+
c. Select **Test Connection** to ensure that Azure AD can connect to Harness. If the connection fails, ensure that your Harness account has *Admin* permissions, and then try again.
124132

125-
6. In the **Notification Email** field, enter the email address of a person or group who should receive the provisioning error notifications and check the checkbox - **Send an email notification when a failure occurs**.
133+
1. In the **Notification Email** box, enter the email address of a person or group that should receive the provisioning error notifications, and then select the **Send an email notification when a failure occurs** check box.
126134

127-
![Notification Email](common/provisioning-notification-email.png)
135+
![The "Notification Email" box](common/provisioning-notification-email.png)
128136

129-
7. Click **Save**.
137+
1. Select **Save**.
130138

131-
8. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Harness**.
139+
1. Under **Mappings**, select **Synchronize Azure Active Directory Users to Harness**.
132140

133-
![Harness User Mappings](media/harness-provisioning-tutorial/usermappings.png)
141+
![Harness "Synchronize Azure Active Directory Users to Harness" link](media/harness-provisioning-tutorial/usermappings.png)
134142

135-
9. Review the user attributes that are synchronized from Azure AD to Harness in the **Attribute Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Harness for update operations. Select the **Save** button to commit any changes.
143+
1. Under **Attribute Mappings**, review the user attributes that are synchronized from Azure AD to Harness. The attributes selected as *Matching* are used to match the user accounts in Harness for update operations. Select **Save** to commit any changes.
136144

137-
![Harness User Attributes](media/harness-provisioning-tutorial/userattributes.png)
145+
![Harness user "Attribute Mappings" pane](media/harness-provisioning-tutorial/userattributes.png)
138146

139-
10. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to Harness**.
147+
1. Under **Mappings**, select **Synchronize Azure Active Directory Groups to Harness**.
140148

141-
![Harness Group Mappings](media/harness-provisioning-tutorial/groupmappings.png)
149+
![Harness "Synchronize Azure Active Directory Groups to Harness" link](media/harness-provisioning-tutorial/groupmappings.png)
142150

143-
11. Review the group attributes that are synchronized from Azure AD to Harness in the **Attribute Mapping** section. The attributes selected as **Matching** properties are used to match the groups in Harness for update operations. Select the **Save** button to commit any changes.
151+
1. Under **Attribute Mappings**, review the group attributes that are synchronized from Azure AD to Harness. The attributes selected as *Matching* properties are used to match the groups in Harness for update operations. Select **Save** to commit any changes.
144152

145-
![Harness Group Attributes](media/harness-provisioning-tutorial/groupattributes.png)
153+
![Harness group "Attribute Mappings" pane](media/harness-provisioning-tutorial/groupattributes.png)
146154

147-
12. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../manage-apps/define-conditional-rules-for-provisioning-user-accounts.md).
155+
1. To configure scoping filters, see [Attribute-based application provisioning with scoping filters](../manage-apps/define-conditional-rules-for-provisioning-user-accounts.md).
148156

149-
13. To enable the Azure AD provisioning service for Harness, change the **Provisioning Status** to **On** in the **Settings** section.
157+
1. Under **Settings**, to enable the Azure AD provisioning service for Harness, toggle the **Provisioning Status** switch to **On**.
150158

151-
![Provisioning Status Toggled On](common/provisioning-toggle-on.png)
159+
![Provisioning Status switch toggled to "On"](common/provisioning-toggle-on.png)
152160

153-
14. Define the users and/or groups that you would like to provision to Harness by choosing the desired values in **Scope** in the **Settings** section.
161+
1. Under **Settings**, in the **Scope** drop-down list, select how you want to sync the users or groups that you're provisioning to Harness.
154162

155163
![Provisioning Scope](common/provisioning-scope.png)
156164

157-
15. When you are ready to provision, click **Save**.
165+
1. When you're ready to provision, select **Save**.
158166

159-
![Saving Provisioning Configuration](common/provisioning-configuration-save.png)
167+
![The provisioning Save button](common/provisioning-configuration-save.png)
160168

161-
This operation starts the initial synchronization of all users and/or groups defined in **Scope** in the **Settings** section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. You can use the **Synchronization Details** section to monitor progress and follow links to provisioning activity report, which describes all actions performed by the Azure AD provisioning service on Harness.
169+
This operation starts the initial sync of the users or groups you're provisioning. The initial sync takes longer to perform than later ones. Syncs occur approximately every 40 minutes, as long as the Azure AD provisioning service is running. To monitor progress, go to the **Synchronization Details** section. You can also follow links to a provisioning activity report, which describes all actions performed by the Azure AD provisioning service on Harness.
162170

163-
For more information on how to read the Azure AD provisioning logs, see [Reporting on automatic user account provisioning](../manage-apps/check-status-user-account-provisioning.md).
171+
For more information about how to read the Azure AD provisioning logs, see [Report on automatic user account provisioning](../manage-apps/check-status-user-account-provisioning.md).
164172

165173
## Additional resources
166174

167-
* [Managing user account provisioning for Enterprise Apps](../manage-apps/configure-automatic-user-provisioning-portal.md)
175+
* [Manage user account provisioning for enterprise apps](../manage-apps/configure-automatic-user-provisioning-portal.md)
168176
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
169177

170178
## Next steps

0 commit comments

Comments
 (0)