Skip to content

Commit 843ebf2

Browse files
GitHubber17GitHubber17
authored
Merge pull request #91617 from v-nagta/knowledgeowl
Product Backlog Item 832034: SaaS App Tutorial: KnowledgeOwl update
2 parents 97bb4e5 + 429e4fd commit 843ebf2

File tree

1 file changed

+83
-149
lines changed

1 file changed

+83
-149
lines changed

‎articles/active-directory/saas-apps/knowledgeowl-tutorial.md

Lines changed: 83 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tutorial: Azure Active Directory integration with KnowledgeOwl | Microsoft Docs'
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with KnowledgeOwl | Microsoft Docs'
33
description: Learn how to configure single sign-on between Azure Active Directory and KnowledgeOwl.
44
services: active-directory
55
documentationCenter: na
@@ -14,32 +14,32 @@ ms.workload: identity
1414
ms.tgt_pltfrm: na
1515
ms.devlang: na
1616
ms.topic: tutorial
17-
ms.date: 04/10/2019
17+
ms.date: 10/14/2019
1818
ms.author: jeedes
1919

20+
ms.collection: M365-identity-device-management
2021
---
21-
# Tutorial: Azure Active Directory integration with KnowledgeOwl
2222

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

26-
* You can control in Azure AD who has access to KnowledgeOwl.
27-
* You can enable your users to be automatically signed-in to KnowledgeOwl (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 KnowledgeOwl with Azure Active Directory (Azure AD). When you integrate KnowledgeOwl 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 KnowledgeOwl.
28+
* Enable your users to be automatically signed-in to KnowledgeOwl 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 KnowledgeOwl, 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 a [free account](https://azure.microsoft.com/free/)
38-
* KnowledgeOwl 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+
* KnowledgeOwl 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
* KnowledgeOwl supports **SP and IDP** initiated SSO
4545
* KnowledgeOwl supports **Just In Time** user provisioning
@@ -48,86 +48,63 @@ In this tutorial, you configure and test Azure AD single sign-on in a test envir
4848

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

51-
**To add KnowledgeOwl from the gallery, perform the following steps:**
52-
53-
1. In the **[Azure portal](https://portal.azure.com)**, on the left navigation panel, click **Azure Active Directory** icon.
54-
55-
![The Azure Active Directory button](common/select-azuread.png)
56-
57-
2. Navigate to **Enterprise Applications** and then select the **All Applications** option.
58-
59-
![The Enterprise applications blade](common/enterprise-applications.png)
60-
61-
3. To add new application, click **New application** button on the top of dialog.
62-
63-
![The New application button](common/add-new-app.png)
64-
65-
4. In the search box, type **KnowledgeOwl**, select **KnowledgeOwl** from result panel then click **Add** button to add the application.
66-
67-
![KnowledgeOwl in the results list](common/search-new-app.png)
68-
69-
## Configure and test Azure AD single sign-on
70-
71-
In this section, you configure and test Azure AD single sign-on with KnowledgeOwl based on a test user called **Britta Simon**.
72-
For single sign-on to work, a link relationship between an Azure AD user and the related user in KnowledgeOwl needs to be established.
73-
74-
To configure and test Azure AD single sign-on with KnowledgeOwl, you need to complete the following building blocks:
75-
76-
1. **[Configure Azure AD Single Sign-On](#configure-azure-ad-single-sign-on)** - to enable your users to use this feature.
77-
2. **[Configure KnowledgeOwl Single Sign-On](#configure-knowledgeowl-single-sign-on)** - to configure the Single Sign-On settings on application side.
78-
3. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with Britta Simon.
79-
4. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable Britta Simon to use Azure AD single sign-on.
80-
5. **[Create KnowledgeOwl test user](#create-knowledgeowl-test-user)** - to have a counterpart of Britta Simon in KnowledgeOwl that is linked to the Azure AD representation of user.
81-
6. **[Test single sign-on](#test-single-sign-on)** - to verify whether the configuration works.
82-
83-
### Configure Azure AD single sign-on
51+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
52+
1. On the left navigation pane, select the **Azure Active Directory** service.
53+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
54+
1. To add new application, select **New application**.
55+
1. In the **Add from the gallery** section, type **KnowledgeOwl** in the search box.
56+
1. Select **KnowledgeOwl** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
8457

85-
In this section, you enable Azure AD single sign-on in the Azure portal.
8658

87-
To configure Azure AD single sign-on with KnowledgeOwl, perform the following steps:
59+
## Configure and test Azure AD single sign-on for KnowledgeOwl
8860

89-
1. In the [Azure portal](https://portal.azure.com/), on the **KnowledgeOwl** application integration page, select **Single sign-on**.
61+
Configure and test Azure AD SSO with KnowledgeOwl 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 KnowledgeOwl.
9062

91-
![Configure single sign-on link](common/select-sso.png)
63+
To configure and test Azure AD SSO with KnowledgeOwl, complete the following building blocks:
9264

93-
2. On the **Select a Single sign-on method** dialog, select **SAML/WS-Fed** mode to enable single sign-on.
65+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
66+
* **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
67+
* **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
68+
1. **[Configure KnowledgeOwl SSO](#configure-knowledgeowl-sso)** - to configure the single sign-on settings on application side.
69+
* **[Create KnowledgeOwl test user](#create-knowledgeowl-test-user)** - to have a counterpart of B.Simon in KnowledgeOwl that is linked to the Azure AD representation of user.
70+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
9471

95-
![Single sign-on select mode](common/select-saml-option.png)
72+
## Configure Azure AD SSO
9673

97-
3. On the **Set up Single Sign-On with SAML** page, click **Edit** icon to open **Basic SAML Configuration** dialog.
74+
Follow these steps to enable Azure AD SSO in the Azure portal.
9875

99-
![Edit Basic SAML Configuration](common/edit-urls.png)
76+
1. In the [Azure portal](https://portal.azure.com/), on the **KnowledgeOwl** application integration page, find the **Manage** section and select **single sign-on**.
77+
1. On the **Select a single sign-on method** page, select **SAML**.
78+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
10079

101-
4. On the **Basic SAML Configuration** section, if you wish to configure the application in **IDP** initiated mode, perform the following steps:
80+
![Edit Basic SAML Configuration](common/edit-urls.png)
10281

103-
![KnowledgeOwl Domain and URLs single sign-on information](common/idp-intiated.png)
82+
1. On the **Basic SAML Configuration** section, if you wish to configure the application in **IDP** initiated mode, enter the values for the following fields:
10483

10584
a. In the **Identifier** text box, type a URL using the following pattern:
106-
107-
||
108-
|-|
85+
86+
| | |
87+
|-|-|
10988
| `https://app.knowledgeowl.com/sp`|
11089
| `https://app.knowledgeowl.com/sp/id/<unique ID>`|
11190

112-
b. In the **Reply URL** text box, type a URL using the following pattern:
113-
114-
||
115-
|-|
91+
b. In the **Reply URL** text box, type a URL using the following pattern:
92+
93+
| | |
94+
|-|-|
11695
| `https://subdomain.knowledgeowl.com/help/saml-login`|
11796
| `https://subdomain.knowledgeowl.com/docs/saml-login`|
11897
| `https://subdomain.knowledgeowl.com/home/saml-login`|
11998
| `https://privatedomain.com/help/saml-login`|
12099
| `https://privatedomain.com/docs/saml-login`|
121100
| `https://privatedomain.com/home/saml-login`|
122101

123-
5. Click **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode:
124-
125-
![KnowledgeOwl Domain and URLs single sign-on information](common/metadata-upload-additional-signon.png)
102+
1. Click **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode:
126103

127104
In the **Sign-on URL** text box, type a URL using the following pattern:
128-
129-
||
130-
|-|
105+
106+
| | |
107+
|-|-|
131108
| `https://subdomain.knowledgeowl.com/help/saml-login`|
132109
| `https://subdomain.knowledgeowl.com/docs/saml-login`|
133110
| `https://subdomain.knowledgeowl.com/home/saml-login`|
@@ -138,49 +115,55 @@ To configure Azure AD single sign-on with KnowledgeOwl, perform the following st
138115
> [!NOTE]
139116
> These values are not real. You'll need to update these value from actual Identifier, Reply URL, and Sign-On URL which is explained later in the tutorial.
140117

141-
6. Your KnowledgeOwl application expects the SAML assertions in a specific format, which requires you to add custom attribute mappings to your SAML token attributes configuration. The following screenshot shows the list of default attributes. Click **Edit** icon to open **User Attributes** dialog.
118+
1. KnowledgeOwl application expects the SAML assertions in a specific format, which requires you to add custom attribute mappings to your SAML token attributes configuration. The following screenshot shows the list of default attributes.
142119

143-
![image](common/edit-attribute.png)
120+
![image](common/default-attributes.png)
144121

145-
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:
122+
1. In addition to above, KnowledgeOwl application expects few more attributes to be passed back in SAML response which are shown below. These attributes are also pre populated but you can review them as per your requirements.
146123

147124
| Name | Source Attribute | Namespace |
148125
| ------------ | -------------------- | -----|
149126
| ssoid | user.mail | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims`|
150127

151-
a. Click **Add new claim** to open the **Manage user claims** dialog.
128+
1. On the **Set up single sign-on with SAML** page, in the **SAML Signing Certificate** section, find **Certificate (Raw)** and select **Download** to download the certificate and save it on your computer.
152129

153-
![image](common/new-save-attribute.png)
154-
155-
![image](common/new-attribute-details.png)
156-
157-
b. In the **Name** textbox, type the attribute name shown for that row.
130+
![The Certificate download link](common/certificateraw.png)
158131

159-
c. From the **Namespace** list, enter the namespace value shown for that row.
132+
1. On the **Set up KnowledgeOwl** section, copy the appropriate URL(s) based on your requirement.
160133

161-
d. Select Source as **Attribute**.
134+
![Copy configuration URLs](common/copy-configuration-urls.png)
162135

163-
e. From the **Source attribute** list, type the attribute value shown for that row.
136+
### Create an Azure AD test user
164137

165-
f. Click **Ok**
138+
In this section, you'll create a test user in the Azure portal called B.Simon.
166139

167-
g. Click **Save**.
140+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
141+
1. Select **New user** at the top of the screen.
142+
1. In the **User** properties, follow these steps:
143+
1. In the **Name** field, enter `B.Simon`.
144+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
145+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
146+
1. Click **Create**.
168147

169-
8. On the **Set up Single Sign-On with SAML** page, in the **SAML Signing Certificate** section, click **Download** to download the **Certificate (Raw)** from the given options as per your requirement and save it on your computer.
148+
### Assign the Azure AD test user
170149

171-
![The Certificate download link](common/certificateraw.png)
150+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to KnowledgeOwl.
172151

173-
9. On the **Set up KnowledgeOwl** section, copy the appropriate URL(s) as per your requirement.
152+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
153+
1. In the applications list, select **KnowledgeOwl**.
154+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
174155

175-
![Copy configuration URLs](common/copy-configuration-urls.png)
156+
![The "Users and groups" link](common/users-groups-blade.png)
176157

177-
a. Login URL
158+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
178159

179-
b. Azure AD Identifier
160+
![The Add User link](common/add-assign-user.png)
180161

181-
c. Logout URL
162+
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.
163+
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.
164+
1. In the **Add Assignment** dialog, click the **Assign** button.
182165

183-
### Configure KnowledgeOwl Single Sign-On
166+
## Configure KnowledgeOwl SSO
184167

185168
1. In a different web browser window, sign into your KnowledgeOwl company site as an administrator.
186169

@@ -220,74 +203,25 @@ To configure Azure AD single sign-on with KnowledgeOwl, perform the following st
220203

221204
![KnowledgeOwl Configuration](./media/knowledgeowl-tutorial/configure4.png)
222205

223-
### Create an Azure AD test user
224-
225-
The objective of this section is to create a test user in the Azure portal called Britta Simon.
226-
227-
1. In the Azure portal, in the left pane, select **Azure Active Directory**, select **Users**, and then select **All users**.
228-
229-
![The "Users and groups" and "All users" links](common/users.png)
230-
231-
2. Select **New user** at the top of the screen.
232-
233-
![New user Button](common/new-user.png)
234-
235-
3. In the User properties, perform the following steps.
236-
237-
![The User dialog box](common/user-properties.png)
238-
239-
a. In the **Name** field enter **BrittaSimon**.
240-
241-
b. In the **User name** field type `[email protected]`
242-
For example, [email protected]
243-
244-
c. Select **Show password** check box, and then write down the value that's displayed in the Password box.
245-
246-
d. Click **Create**.
247-
248-
### Assign the Azure AD test user
249-
250-
In this section, you enable Britta Simon to use Azure single sign-on by granting access to KnowledgeOwl.
251-
252-
1. In the Azure portal, select **Enterprise Applications**, select **All applications**, then select **KnowledgeOwl**.
253-
254-
![Enterprise applications blade](common/enterprise-applications.png)
255-
256-
2. In the applications list, select **KnowledgeOwl**.
257-
258-
![The KnowledgeOwl link in the Applications list](common/all-applications.png)
259-
260-
3. In the menu on the left, select **Users and groups**.
261-
262-
![The "Users and groups" link](common/users-groups-blade.png)
263-
264-
4. Click the **Add user** button, then select **Users and groups** in the **Add Assignment** dialog.
265-
266-
![The Add Assignment pane](common/add-assign-user.png)
267-
268-
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.
269-
270-
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.
271-
272-
7. In the **Add Assignment** dialog click the **Assign** button.
273-
274206
### Create KnowledgeOwl test user
275207

276-
In this section, a user called Britta Simon is created in KnowledgeOwl. KnowledgeOwl 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 KnowledgeOwl, a new one is created after authentication.
208+
In this section, a user called B.Simon is created in KnowledgeOwl. KnowledgeOwl 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 KnowledgeOwl, a new one is created after authentication.
277209

278210
> [!Note]
279211
> If you need to create a user manually, contact [KnowledgeOwl support team](mailto:[email protected]).
280212
281-
### Test single sign-on
213+
## Test SSO
282214

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

285217
When you click the KnowledgeOwl tile in the Access Panel, you should be automatically signed in to the KnowledgeOwl 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).
286218

287-
## Additional Resources
219+
## Additional resources
220+
221+
- [ 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)
288222

289-
- [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)
223+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
290224

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

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

0 commit comments

Comments
 (0)