Skip to content

Commit ca679c9

Browse files
JarbasHorstJarbasHorst
authored
Merge branch 'main' into user/yadongzhai/updatebetadocument
2 parents 2f51d5e + a15247c commit ca679c9

File tree

187 files changed

+2174
-376
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

187 files changed

+2174
-376
lines changed

‎api-reference/beta/api/b2cidentityuserflow-list-userattributeassignments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2222
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_userattributeassignments" } -->
2323
[!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-userattributeassignments-permissions.md)]
2424

25+
[!INCLUDE [rbac-b2xb2c-user-flows-apis](../includes/rbac-for-apis/rbac-b2xb2c-user-flows-apis.md)]
26+
2527
## HTTP request
2628

2729
<!-- {

‎api-reference/beta/api/b2cidentityuserflow-post-userattributeassignments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2222
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_post_userattributeassignments" } -->
2323
[!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-post-userattributeassignments-permissions.md)]
2424

25+
[!INCLUDE [rbac-b2xb2c-user-flows-apis](../includes/rbac-for-apis/rbac-b2xb2c-user-flows-apis.md)]
26+
2527
## HTTP request
2628

2729
<!-- {

‎api-reference/beta/api/b2xidentityuserflow-list-userattributeassignments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2222
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_userattributeassignments" } -->
2323
[!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-userattributeassignments-permissions.md)]
2424

25+
[!INCLUDE [rbac-b2xb2c-user-flows-apis](../includes/rbac-for-apis/rbac-b2xb2c-user-flows-apis.md)]
26+
2527
## HTTP request
2628

2729
<!-- {

‎api-reference/beta/api/b2xidentityuserflow-post-userattributeassignments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2222
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_post_userattributeassignments" } -->
2323
[!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-post-userattributeassignments-permissions.md)]
2424

25+
[!INCLUDE [rbac-b2xb2c-user-flows-apis](../includes/rbac-for-apis/rbac-b2xb2c-user-flows-apis.md)]
26+
2527
## HTTP request
2628

2729
<!-- {

‎api-reference/beta/api/cloudlicensing-groupcloudlicensing-list-usagerights.md

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
title: "List usageRights for group"
3+
description: "Get a list of the usageRight objects granted to a group."
4+
author: "patrick-starrin"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-licensing"
7+
doc_type: apiPageType
8+
---
9+
10+
# List usageRights for group
11+
12+
Namespace: microsoft.graph.cloudLicensing
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a group.
17+
18+
## Permissions
19+
20+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- { "blockType": "permissions", "name": "cloudlicensing_groupcloudlicensing_list_usagerights" } -->
23+
[!INCLUDE [permissions-table](../includes/permissions/cloudlicensing-groupcloudlicensing-list-usagerights-permissions.md)]
24+
25+
## HTTP request
26+
27+
<!-- {
28+
"blockType": "ignored"
29+
}
30+
-->
31+
``` http
32+
GET /groups/{groupId}/cloudLicensing/usageRights
33+
```
34+
35+
## Optional query parameters
36+
37+
This method supports the `$select` and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
38+
39+
The following examples show how to get usage rights information for groups based on specific filters:
40+
41+
<!-- {
42+
"blockType": "ignored"
43+
}
44+
-->
45+
``` http
46+
GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=skuId eq 639dec6b-bb19-468b-871c-c5c441c4b0cb
47+
GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=skuId in (639dec6b-bb19-468b-871c-c5c441c4b0cb, a403ebcc-fae0-4ca2-8c8c-7a907fd6c235)
48+
GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318)
49+
GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId in (113feb6c-3fe4-4440-bddc-54d774bf0318, 2049e525-b859-401b-b2a0-e0a31c4b1fe4))
50+
```
51+
52+
## Request headers
53+
54+
|Name|Description|
55+
|:---|:---|
56+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
57+
58+
## Request body
59+
60+
Don't supply a request body for this method.
61+
62+
## Response
63+
64+
If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) objects in the response body.
65+
66+
## Examples
67+
68+
### Example 1: Get all usage rights for a group
69+
70+
The following example shows how to get all usage rights granted to a group.
71+
72+
#### Request
73+
74+
The following example shows a request.
75+
<!-- {
76+
"blockType": "request",
77+
"name": "cloudlicensing-groupusageright-list-example-1"
78+
}
79+
-->
80+
``` http
81+
GET https://graph.microsoft.com/beta/groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights
82+
```
83+
84+
#### Response
85+
86+
The following example shows the response.
87+
>**Note:** The response object shown here might be shortened for readability.
88+
<!-- {
89+
"blockType": "response",
90+
"truncated": true,
91+
"@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)"
92+
}
93+
-->
94+
``` http
95+
HTTP/1.1 200 OK
96+
Content-Type: application/json
97+
98+
{
99+
"value": [
100+
{
101+
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
102+
"id": "1e373a1d-1f05-28cf-bfc0-ee0ecfd3db15",
103+
"skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb",
104+
"skuPartNumber": "Microsoft_365_Copilot",
105+
"services": [
106+
{
107+
"@odata.type": "microsoft.graph.cloudLicensing.service",
108+
"assignableTo": "user,group",
109+
"planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c",
110+
"planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365"
111+
}
112+
]
113+
}
114+
]
115+
}
116+
```
117+
118+
### Example 2: Get all usage rights for a group with a specific service plan
119+
120+
The following example shows how to get all usage rights granted to a group for a specific service plan.
121+
122+
#### Request
123+
124+
The following example shows a request.
125+
<!-- {
126+
"blockType": "request",
127+
"name": "cloudlicensing-groupusageright-list-example-2"
128+
}
129+
-->
130+
``` http
131+
GET https://graph.microsoft.com/beta/groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318)
132+
```
133+
134+
#### Response
135+
136+
The following example shows the response.
137+
>**Note:** The response object shown here might be shortened for readability.
138+
<!-- {
139+
"blockType": "response",
140+
"truncated": true,
141+
"@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)"
142+
}
143+
-->
144+
``` http
145+
HTTP/1.1 200 OK
146+
Content-Type: application/json
147+
148+
{
149+
"value": [
150+
{
151+
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
152+
"id": "5bbc716a-f73f-4cc1-bf16-53d38b407b8f",
153+
"skuId": "75398b2a-b060-4057-9ae2-9eb00ef68579",
154+
"skuPartNumber": "Copilot_Pro",
155+
"services": [
156+
{
157+
"@odata.type": "microsoft.graph.cloudLicensing.service",
158+
"assignableTo": "group",
159+
"planId": "113feb6c-3fe4-4440-bddc-54d774bf0318",
160+
"planName": "EXCHANGE_S_FOUNDATION"
161+
}
162+
]
163+
}
164+
]
165+
}
166+
```

‎api-reference/beta/api/cloudlicensing-usageright-get.md

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
---
2+
title: "Get usageRight"
3+
description: "Get the properties and relationships of a usageRight for a user or group."
4+
author: "patrick-starrin"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-licensing"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get usageRight
11+
12+
Namespace: microsoft.graph.cloudLicensing
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get the properties and relationships of a [usageRight](../resources/cloudlicensing-usageright.md) for a [user](../resources/user.md) or [group](../resources/group.md).
17+
18+
## Permissions
19+
20+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
Permissions to get a **usageRight** for a user:
23+
24+
<!-- { "blockType": "ignored"} -->
25+
``` http
26+
GET /me/cloudLicensing/usageRights/{usageRightId}
27+
GET /users/{userId}/cloudLicensing/usageRights/{usageRightId}
28+
```
29+
30+
<!-- { "blockType": "permissions", "name": "cloudlicensing_usageright_get" } -->
31+
[!INCLUDE [permissions-table](../includes/permissions/cloudlicensing-usageright-get-permissions.md)]
32+
33+
Permissions to get a **usageRight** for a group:
34+
35+
<!-- { "blockType": "ignored"} -->
36+
``` http
37+
GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId}
38+
```
39+
40+
<!-- { "blockType": "permissions", "name": "cloudlicensing_usageright_get", "requestUrls": "GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId}" } -->
41+
|Permission type|Least privileged permissions|Higher privileged permissions|
42+
|:---|:---|:---|
43+
|Delegated (work or school account)|Group-UsageRight.Read.All|Directory.Read.All, Directory.ReadWrite.All, Group-CloudLicensing.Read, Group-CloudLicensing.Read.All, Group.Read.All, Group.ReadWrite.All, User.Read.All, User.ReadWrite.All|
44+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
45+
|Application|Group-UsageRight.Read.All|Directory.Read.All, Directory.ReadWrite.All, Group-CloudLicensing.Read.All, Group.Read.All, Group.ReadWrite.All, User.Read.All, User.ReadWrite.All|
46+
47+
## HTTP request
48+
49+
<!-- {
50+
"blockType": "ignored"
51+
}
52+
-->
53+
``` http
54+
GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId}
55+
GET /me/cloudLicensing/usageRights/{usageRightId}
56+
GET /users/{userId}/cloudLicensing/usageRights/{usageRightId}
57+
```
58+
59+
## Optional query parameters
60+
61+
This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
62+
63+
## Request headers
64+
65+
|Name|Description|
66+
|:---|:---|
67+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
68+
69+
## Request body
70+
71+
Don't supply a request body for this method.
72+
73+
## Response
74+
75+
If successful, this method returns a `200 OK` response code and a [microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) object in the response body.
76+
77+
## Examples
78+
79+
### Example 1: Get a usageRight for a user
80+
81+
The following example shows how to get a usage right for a user.
82+
83+
#### Request
84+
85+
The following example shows a request.
86+
<!-- {
87+
"blockType": "request",
88+
"name": "cloudlicensing-usageright-get-example",
89+
"sampleKeys": ["48fbdf70-9e09-40df-9dbe-17af483ab113","i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3"]
90+
}
91+
-->
92+
``` http
93+
GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights/i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3
94+
```
95+
96+
#### Response
97+
98+
The following example shows the response.
99+
>**Note:** The response object shown here might be shortened for readability.
100+
<!-- {
101+
"blockType": "response",
102+
"truncated": true,
103+
"@odata.type": "microsoft.graph.cloudLicensing.usageRight"
104+
}
105+
-->
106+
``` http
107+
HTTP/1.1 200 OK
108+
Content-Type: application/json
109+
110+
{
111+
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
112+
"id": "i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3",
113+
"skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb",
114+
"skuPartNumber": "Microsoft_365_Copilot",
115+
"services": [
116+
{
117+
"@odata.type": "microsoft.graph.cloudLicensing.service",
118+
"assignableTo": "user,group",
119+
"planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c",
120+
"planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365"
121+
}
122+
]
123+
}
124+
```
125+
126+
### Example 2: Get a usageRight for a group
127+
128+
The following example shows how to get a usage right for a group.
129+
130+
#### Request
131+
132+
The following example shows a request.
133+
<!-- {
134+
"blockType": "request",
135+
"name": "cloudlicensing-usageright-get-2-example",
136+
"sampleKeys": ["1003985b-dfc1-4f42-97d4-65f70a335ca8","j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4"]
137+
}
138+
-->
139+
``` http
140+
GET https://graph.microsoft.com/beta/groups/1003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights/j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4
141+
```
142+
143+
#### Response
144+
145+
The following example shows the response.
146+
>**Note:** The response object shown here might be shortened for readability.
147+
<!-- {
148+
"blockType": "response",
149+
"truncated": true,
150+
"@odata.type": "microsoft.graph.cloudLicensing.usageRight"
151+
}
152+
-->
153+
``` http
154+
HTTP/1.1 200 OK
155+
Content-Type: application/json
156+
157+
{
158+
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
159+
"id": "j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4",
160+
"skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb",
161+
"skuPartNumber": "Microsoft_365_Copilot",
162+
"services": [
163+
{
164+
"@odata.type": "microsoft.graph.cloudLicensing.service",
165+
"assignableTo": "user,group",
166+
"planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c",
167+
"planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365"
168+
}
169+
]
170+
}
171+
```

0 commit comments

Comments
 (0)