Skip to content

Commit bf3025c

Browse files
learn-build-service-prod[bot]learn-build-service-prod[bot]
authored
Merge pull request #28419 from microsoftgraph/main
Merge to publish.
2 parents eddf3ee + 92d8c71 commit bf3025c

66 files changed

Lines changed: 2478 additions & 116 deletions

File tree

Some content is hidden

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

‎.github/prompts/author-api-docs.prompt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
agent: agent
33
model: Claude Sonnet 4.5 (copilot)
4-
tools: ['usages', 'problems', 'fetch', 'githubRepo', 'runCommands', 'edit/createFile', 'edit/editFiles', 'search']
4+
tools: ['usages', 'problems', 'fetch', 'githubRepo', 'runCommands', 'edit/createFile', 'edit/editFiles', 'search', 'github/*']
55
description: Author and update Microsoft Graph API reference documentation using autogenerated doc stubs
66
name: authorAPIdocs
77
---

‎.github/prompts/author-api-docs/common.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If a conflict is significant, flag it to the author in the final summary but fol
3131
Gather both values in a **single upfront step** to minimize round-trips with the author:
3232

3333
1. **Attempt auto-detection first:**
34-
- `author`: Use the GitHub login of the signed-in user
34+
- `author`: Use the `get_me` tool to get the GitHub Login of the signed-in user
3535
- `ms.subservice`: Inspect existing API/resource files being updated and use their `ms.subservice` value (exclude enum files)
3636

3737
2. **If either value cannot be inferred**, ask the author for both at once:

‎api-reference/beta/api/accesspackagesubject-get.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Get the properties of an existing [accessPackageSubject](../resources/accesspackagesubject.md) object.
17+
Get the properties of an external directory user represented by an existing [accessPackageSubject](../resources/accesspackagesubject.md) object.
1818

1919
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
2020

@@ -33,7 +33,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
3333
}
3434
-->
3535
```http
36-
GET /identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')
36+
GET /identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfExternalDirectoryUser}')
3737
```
3838

3939
## Request headers
@@ -61,7 +61,7 @@ If successful, this method returns a `200 OK` response code and the requested [a
6161
}
6262
-->
6363
```msgraph-interactive
64-
GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')
64+
GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfExternalDirectoryUser}')
6565
```
6666

6767
# [C#](#tab/csharp)

‎api-reference/beta/api/driveitem-removeretentionlabel.md‎

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: "driveItem: removeRetentionLabel"
3-
description: "Remove a retention label from a driveItem."
3+
description: "Remove the retention label from a driveItem."
44
author: "kyracatwork"
55
ms.localizationpriority: medium
66
ms.subservice: "onedrive"
77
doc_type: apiPageType
8-
ms.date: 11/06/2025
8+
ms.date: 02/03/2026
99
---
1010

1111
# driveItem: removeRetentionLabel
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Remove a retention label from a [driveItem](../resources/driveitem.md).
17+
Remove the retention label from a [driveItem](../resources/driveitem.md). This operation clears the retention label and all associated retention settings enforced on the item.
1818

1919
For information about retention labels from an administrator's perspective, see [Use retention labels to manage the lifecycle of documents stored in SharePoint](/microsoft-365/compliance/auto-apply-retention-labels-scenario).
2020

@@ -28,7 +28,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2828
[!INCLUDE [permissions-table](../includes/permissions/driveitem-removeretentionlabel-permissions.md)]
2929

3030
> [!NOTE]
31-
> `Sites.FullControl.All` is the least privileged permission required to remove retention labels that classify the content as records.
31+
> * `Sites.FullControl.All` is the least privileged permission required to remove retention labels that classify the content as records.
32+
> * The removal of a *Record* retention label isn't supported when using app-only authentication. This operation requires a delegated user context.
3233
3334
[!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-driveitem-permissions.md)]
3435

@@ -40,6 +41,9 @@ Choose the permission or permissions marked as least privileged for this API. Us
4041
-->
4142
```http
4243
DELETE /drives/{drive-id}/items/{item-id}/retentionLabel
44+
DELETE /groups/{group-id}/drive/items/{item-id}/retentionLabel
45+
DELETE /me/drive/items/{item-id}/retentionLabel
46+
DELETE /users/{user-id}/drive/items/{item-id}/retentionLabel
4347
```
4448

4549
## Request headers
@@ -56,9 +60,19 @@ Don't supply a request body for this method.
5660

5761
If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
5862

63+
### Error responses
64+
65+
| Error code | HTTP status | Description |
66+
|:-----------------|:------------|:-------------------------------------------------------------------|
67+
| notSupported | 400 | App-only callers aren't supported for SharePoint Embedded containers. |
68+
| accessDenied | 403 | The caller doesn't have permission to remove the retention label. |
69+
| itemNotFound | 404 | The item can't be found or is no longer accessible. |
70+
5971
## Examples
6072

61-
### Request
73+
### Example 1: Remove the retention label from a driveItem
74+
The following example shows how to remove the retential label from a **driveItem** object.
75+
#### Request
6276

6377
The following example shows a request.
6478

@@ -73,7 +87,7 @@ The following example shows a request.
7387
DELETE https://graph.microsoft.com/beta/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/retentionLabel
7488
```
7589

76-
### Response
90+
#### Response
7791

7892
The following example shows the response.
7993

@@ -85,3 +99,42 @@ The following example shows the response.
8599
```http
86100
HTTP/1.1 204 No Content
87101
```
102+
103+
### Example 2: Remove the retention label from a driveItem that fails due to insufficient permissions
104+
The following example shows how to remove the retention label from a **driveItem** object that fails due to insufficient permissions.
105+
#### Request
106+
The following example shows a request.
107+
<!-- {
108+
"blockType": "request",
109+
"name": "driveItem_removeRetentionLabel_spe_permissions_error",
110+
"sampleKeys": ["b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7", "01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK"]
111+
}
112+
-->
113+
114+
```http
115+
DELETE https://graph.microsoft.com/beta/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/retentionLabel
116+
```
117+
118+
#### Response
119+
The following example shows the response.
120+
<!-- {
121+
"blockType": "response",
122+
"truncated": true,
123+
"@odata.type": "microsoft.graph.error"
124+
} -->
125+
126+
```http
127+
HTTP/1.1 403 Forbidden
128+
Content-Type: application/json
129+
130+
{
131+
"error": {
132+
"code": "accessDenied",
133+
"message": "Access Denied: Do not have enough permission.",
134+
"innerError": {
135+
"request-id": "12345678-1234-1234-1234-123456789012",
136+
"date": "2025-02-03T10:30:00"
137+
}
138+
}
139+
}
140+
```

‎api-reference/beta/api/filestoragecontainer-archive.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "fileStorageContainer: archive"
3+
description: "Archive an active fileStorageContainer."
4+
author: "singhman-msft"
5+
ms.date: 11/15/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "onedrive"
8+
doc_type: apiPageType
9+
---
10+
11+
# fileStorageContainer: archive
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Archive an active [fileStorageContainer](../resources/filestoragecontainer.md).
18+
19+
This action updates the [archivalDetails](../resources/sitearchivaldetails.md).
20+
21+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
22+
23+
## Permissions
24+
25+
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).
26+
27+
<!-- { "blockType": "permissions", "name": "filestoragecontainer_archive" } -->
28+
[!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-archive-permissions.md)]
29+
30+
[!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)]
31+
32+
> [!NOTE]
33+
> When delegated permissions are used, only members who are assigned the `PrincipalOwner` or `Owner` role can call this method.
34+
35+
## HTTP request
36+
37+
```http
38+
POST /storage/fileStorage/containers/{containerId}/archive
39+
```
40+
41+
## Request body
42+
43+
Don't supply a request body for this method.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Response
52+
53+
If successful, this method returns a `204 No Content` response code.
54+
55+
## Examples
56+
57+
### Request
58+
59+
The following example shows a request.
60+
61+
<!-- {
62+
"blockType": "request",
63+
"name": "archive_fileStorageContainer",
64+
"sampleKeys": ["b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0"]
65+
}
66+
-->
67+
```http
68+
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0/archive
69+
```
70+
71+
### Response
72+
73+
The following example shows the response.
74+
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true
78+
}
79+
-->
80+
```http
81+
HTTP/1.1 204 No Content
82+
```

‎api-reference/beta/api/filestoragecontainer-unarchive.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "fileStorageContainer: unarchive"
3+
description: "Unarchive an archived fileStorageContainer."
4+
author: "singhman-msft"
5+
ms.date: 11/15/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "onedrive"
8+
doc_type: apiPageType
9+
---
10+
11+
# fileStorageContainer: unarchive
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Unarchive an archived [fileStorageContainer](../resources/filestoragecontainer.md).
18+
19+
This action updates the [archivalDetails](../resources/sitearchivaldetails.md).
20+
21+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
22+
23+
## Permissions
24+
25+
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).
26+
27+
<!-- { "blockType": "permissions", "name": "filestoragecontainer_unarchive" } -->
28+
[!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-unarchive-permissions.md)]
29+
30+
[!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)]
31+
32+
> [!NOTE]
33+
> When delegated permissions are used, only members who are assigned the `PrincipalOwner` or `Owner` role can call this method.
34+
35+
## HTTP request
36+
37+
```http
38+
POST /storage/fileStorage/containers/{containerId}/unarchive
39+
```
40+
41+
## Request body
42+
43+
Don't supply a request body for this method.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Response
52+
53+
If successful, this method returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the container that is unarchived. To check the status of the unarchive operation, make a GET request to the location URL.
54+
55+
## Examples
56+
57+
### Request
58+
59+
The following example shows a request.
60+
61+
<!-- {
62+
"blockType": "request",
63+
"name": "unarchive_fileStorageContainer",
64+
"sampleKeys": ["b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0"]
65+
}
66+
-->
67+
```http
68+
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0/unarchive
69+
```
70+
71+
### Response
72+
73+
The following example shows the response.
74+
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true
78+
}
79+
-->
80+
```http
81+
HTTP/1.1 202 Accepted
82+
Location: https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0
83+
```

0 commit comments

Comments
 (0)