You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/Concepts/role-based-access-control.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Collaborate with other authors and editors using role-based access control (RBAC
14
14
All permissions are controlled by the permissions placed on the QnA Maker resource. These permissions align to read, write, publish, and full access.
15
15
16
16
This RBAC feature includes:
17
-
* AAD is 100% backward compatible with key-based authentication for owners and contributors. Customers can use either key or RBAC-based authentication in their requests.
17
+
*Azure Active Directory (AAD) is 100% backward compatible with key-based authentication for owners and contributors. Customers can use either key-based authentication or RBAC-based authentication in their requests.
18
18
* Quickly add authors and editors to all knowledge bases in the resource because control is at the resource level, not at the knowledge base level.
19
19
20
20
## Access is provided by a defined role
@@ -26,17 +26,23 @@ This RBAC feature includes:
26
26
The following diagram shows the flow, from the author's perspective, for signing into the QnA Maker portal and using the authoring APIs.
27
27
28
28
> [!div class="mx-imgBorder"]
29
-
> 
29
+
> 
30
30
31
31
|Steps|Description|
32
32
|--|--|
33
-
|1|Portal Acquires token for cognitive services resource.|
34
-
|2|Portal Calls the appropriate API passing the tokens instead of keys.|
35
-
|3|APIM validated the tokens.|
36
-
|4 |APIM calls QnAMaker Service like any regular service.|
33
+
|1|Portal Acquires token for QnA Maker resource.|
34
+
|2|Portal Calls the appropriate QnA Maker authoring API (APIM) passing the token instead of keys.|
35
+
|3|QnA Maker API validates the token.|
36
+
|4 |QnA Maker API calls QnAMaker Service.|
37
37
38
38
Learn more about how to [set up authentication if you intend to call the authoring APIs](../How-To/collaborate-knowledge-base.md).
39
39
40
+
## Authenticate by QnA Maker portal or API
41
+
42
+
If you author and collaborate using the QnA Maker portal, after you [add the appropriate role to the resource for a collaborator](../How-To/collaborate-knowledge-base.md), the QnA Maker portal manages all the access permissions.
43
+
44
+
If you author and collaborate using the APIs, either through REST or the SDKs, you need to [create a service principal](../../authentication.md#assign-a-role-to-a-service-principal) to manage the authentication.
45
+
40
46
## Next step
41
47
42
48
* Design a knowledge base for [languages](design-language-culture.md) and for [client applications](integration-with-other-applications.md)
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/How-To/collaborate-knowledge-base.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,21 +7,17 @@ ms.date: 03/17/2020
7
7
8
8
# Collaboration with authors and editors
9
9
10
-
Collaboration is provided at the QnA Maker resource level in two different ways:
11
-
12
-
***Authentication key** for owner and contributor roles. This is the original method of providing access. at subscription level
13
-
14
-
* Authentication via **bearer tokens** for other roles. This is a newer method of providing access.
10
+
Collaboration is provided at the QnA Maker resource level to allow you to restrict collaborator access based on the collaborator's role. Learn more about QnA Maker collaborator authentication [concepts](../Concepts/role-based-access-control.md).
15
11
16
12
# Add role-based access (RBAC) to your QnA Maker resource
17
13
18
-
QnA Maker allows multiple people to collaborate on all knowledge bases in the same QnA Maker resource. This feature is provided with the Azure [Role-Based Access Control](https://docs.microsoft.com/azure/active-directory/role-based-access-control-configure).
14
+
QnA Maker allows multiple people to collaborate on all knowledge bases in the same QnA Maker resource. This feature is provided with the Azure [Role-Based Access Control](../../../active-directory/role-based-access-control-configure.md).
19
15
20
16
## Access at the QnA Maker resource level
21
17
22
-
You cannot share a particular knowledge base in a QnA Maker service. If you want more granular access control, consider distributing your knowledge bases across different QnA Maker services.
18
+
You cannot share a particular knowledge base in a QnA Maker service. If you want more granular access control, consider distributing your knowledge bases across different QnA Maker resources, then add roles to each resource.
23
19
24
-
## Use authentication key for owner and contributor
20
+
## Add role to resource
25
21
26
22
### Add a user account to the QnA Maker resource
27
23
@@ -57,11 +53,11 @@ The following steps use the collaborator role but any of the [roles](../referenc
57
53
58
54
When the person you shared your QnA Maker service with logs into the [QnA Maker portal](https://qnamaker.ai), they can see all the knowledge bases in that service based on their role.
59
55
60
-
## Use bearer token for other roles
61
-
62
-
Bearer
63
-
64
56
## Next steps
65
57
66
58
> [!div class="nextstepaction"]
67
59
> [Test a knowledge base](./test-knowledge-base.md)
60
+
61
+
Learn more about collaboration:
62
+
*[Azure](../../../active-directory/role-based-access-control-configure.md) role-based access control
63
+
* QnA Maker role-based access control [concepts](../Concepts/role-based-access-control.md)
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/includes/role-based-access-control.md
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,12 @@ ms.custom: include file
6
6
ms.date: 03/11/2020
7
7
---
8
8
9
-
The following roles are managed with the QnA Maker authentication key:
9
+
The following roles are provided for collaboration:
10
10
11
-
|Role|Type|Functionalities|API permissions|
11
+
|Role|Functionalities|API Access|API permissions|
12
12
|--|--|--|--|
13
-
|Owner|Authentication Key|All||
14
-
|Contributor|Authentication Key|All except ability to add new members to roles||
15
-
16
-
17
-
The following roles are managed with role-based access control:
18
-
19
-
|Role|Type|Functionalities|API permissions|
20
-
|--|--|--|--|
21
-
|QnA Maker Read<br>(read)|Active Directory|Export/Download<br>Test|1. Download KB API<br>2. List KBs for user API<br>3. Get Knowledge base details<br>4. Download Alterations<br>Generate Answer |
22
-
|QnA Maker Editor<br>(read/write)|Active Directory|Export/Download<br>Test<br>Update KB<br>Export KB<br>Import KB<br>Replace KB<br>Create KB|1. Create KB API<br>2. Update KB API<br>3. Replace KB API<br>4. Replace Alterations<br>5. "Train API" [in new service model v5]|
23
-
|Cognitive Service User<br>(read/write/publish)|Active Directory||All|
13
+
|Owner|All|Authentication Key|All|
14
+
|Contributor|All except ability to add new members to roles|Authentication Key|All except ability to add new members to roles|
15
+
|QnA Maker Read<br>(read)|Export/Download<br>Test|Bearer token|1. Download KB API<br>2. List KBs for user API<br>3. Get Knowledge base details<br>4. Download Alterations<br>Generate Answer |
16
+
|QnA Maker Editor<br>(read/write)|Export/Download<br>Test<br>Update KB<br>Export KB<br>Import KB<br>Replace KB<br>Create KB|Bearer token|1. Create KB API<br>2. Update KB API<br>3. Replace KB API<br>4. Replace Alterations<br>5. "Train API" [in new service model v5]|
17
+
|Cognitive Service User<br>(read/write/publish)|All|Bearer token|All|
0 commit comments