Skip to content

Commit fba9367

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #25979 from microsoftgraph/groupLifecyclePolicy
Surface group lifecycle policy on TOC
2 parents 7e498db + 9794411 commit fba9367

11 files changed

+74
-27
lines changed

‎api-reference/beta/api/grouplifecyclepolicy-addgroup.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "groupLifecyclePolicy: addGroup"
3-
description: "Adds a group to a lifecycle policy."
3+
description: "Add a group to a lifecycle policy."
44
author: "yuhko-msft"
55
ms.reviewer: "mbhargav, khotzteam, aadgroupssg"
66
ms.localizationpriority: medium
@@ -15,7 +15,7 @@ Namespace: microsoft.graph
1515

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

18-
Adds specific groups to a lifecycle policy. This action limits the group lifecycle policy to a set of groups only if the **managedGroupTypes** property of [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md) is set to `Selected`.
18+
Add a group to a [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md). This action is supported only if the **managedGroupTypes** property of the policy is set to `Selected`.
1919

2020
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
2121

@@ -55,7 +55,7 @@ Only one group can be added per request.
5555

5656
## Response
5757

58-
If successful, this method returns `200 OK` response code. If the group is added to the policy, a `true` value is returned in the response body. Otherwise, a `false` value is returned in the response body.
58+
If successful, this method returns `200 OK` response code. If the group is added to the policy, a `true` value is returned in the response body and the **expirationDateTime** property of the added group is set based on the policy's **groupLifetimeInDays** value. Otherwise, a `false` value is returned in the response body.
5959

6060
## Example
6161

@@ -88,7 +88,8 @@ HTTP/1.1 200 OK
8888
Content-type: application/json
8989
9090
{
91-
"value": true
91+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean",
92+
"value": true
9293
}
9394
```
9495

‎api-reference/beta/api/grouplifecyclepolicy-post-grouplifecyclepolicies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Namespace: microsoft.graph
1515

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

18-
Creates a new [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md).
18+
Creates a new [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md). Only one policy exists in the tenant.
1919

2020
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
2121

@@ -107,7 +107,7 @@ Content-type: application/json
107107

108108
### Response
109109

110-
Note: The response object shown here might be shortened for readability.
110+
>**Note:** The response object shown here might be shortened for readability.
111111
112112
<!-- {
113113
"blockType": "response",

‎api-reference/beta/api/grouplifecyclepolicy-renewgroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In the request body, provide a JSON object with the following parameters.
5050

5151
| Parameter | Type | Description |
5252
| :-------- | :--- | :---------------------------- |
53-
| groupId | Guid | The id of the group to renew. |
53+
| groupId | Guid | The object ID of the group to renew. |
5454

5555
## Response
5656

‎api-reference/beta/resources/grouplifecyclepolicy.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,20 @@ Represents a lifecycle policy for a Microsoft 365 group. A group lifecycle polic
2020
- Once renewed, the group expiration is extended by the number of days defined in the policy and the group's **expirationDateTime** property defines the new expiration date.
2121
- If the group is not renewed, it expires and is deleted. The group can be restored within a period of 30 days from deletion.
2222

23+
For more information, see [Manage the lifecycle of Microsoft 365 groups in your tenant](/entra/identity/users/groups-lifecycle).
24+
2325
## Methods
2426

25-
| Method | Return Type | Description |
26-
| :--------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :------------------------------------------------------------------ |
27-
| [Get policy](../api/grouplifecyclepolicy-get.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Read properties and relationships of a groupLifecyclePolicy object. |
28-
| [List policies](../api/grouplifecyclepolicy-list.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) collection | List all the groupLifecyclePolicies. |
29-
| [Update policy](../api/grouplifecyclepolicy-update.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Update a groupLifecyclePolicy object. |
30-
| [Delete policy](../api/grouplifecyclepolicy-delete.md) | None | Delete a groupLifecyclePolicy object. |
31-
| [Add group](../api/grouplifecyclepolicy-addgroup.md) | None | Add a group to a lifecycle policy |
32-
| [Remove group](../api/grouplifecyclepolicy-removegroup.md) | None | Remove a group to a lifecycle policy. |
33-
| [Renew group](../api/grouplifecyclepolicy-renewgroup.md) | None | Renew a group's expiration date. |
27+
| Method | Return Type | Description |
28+
|:-|:-|:-|
29+
| [List](../api/grouplifecyclepolicy-list.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) collection | List all the groupLifecyclePolicies. Only one policy exists in a tenant. |
30+
| [Create](../api/grouplifecyclepolicy-post-grouplifecyclepolicies.md) | [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md) | Create a new groupLifecyclePolicy object. |
31+
| [Get](../api/grouplifecyclepolicy-get.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Read properties and relationships of a groupLifecyclePolicy object. |
32+
| [Update](../api/grouplifecyclepolicy-update.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Update a groupLifecyclePolicy object. |
33+
| [Delete](../api/grouplifecyclepolicy-delete.md) | None | Delete a groupLifecyclePolicy object. |
34+
| [Add group](../api/grouplifecyclepolicy-addgroup.md) | None | Add a group to a lifecycle policy |
35+
| [Remove group](../api/grouplifecyclepolicy-removegroup.md) | None | Remove a group from a lifecycle policy. |
36+
| [Renew group](../api/grouplifecyclepolicy-renewgroup.md) | None | Renew a group's expiration date. |
3437

3538
## Properties
3639

‎api-reference/beta/toc/groups/toc.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,3 +218,23 @@ items:
218218
href: ../../api/group-unsubscribebymail.md
219219
- name: Reset unseen count
220220
href: ../../api/group-resetunseencount.md
221+
- name: Group lifecycle policy
222+
items:
223+
- name: Group lifecycle policy
224+
href: ../../resources/grouplifecyclepolicy.md
225+
- name: List
226+
href: ../../api/grouplifecyclepolicy-list.md
227+
- name: Create
228+
href: ../../api/grouplifecyclepolicy-post-grouplifecyclepolicies.md
229+
- name: Get
230+
href: ../../api/grouplifecyclepolicy-get.md
231+
- name: Update
232+
href: ../../api/grouplifecyclepolicy-update.md
233+
- name: Delete
234+
href: ../../api/grouplifecyclepolicy-delete.md
235+
- name: Add group
236+
href: ../../api/grouplifecyclepolicy-addgroup.md
237+
- name: Remove group
238+
href: ../../api/grouplifecyclepolicy-removegroup.md
239+
- name: Renew group
240+
href: ../../api/grouplifecyclepolicy-renewgroup.md

‎api-reference/beta/toc/toc.mapping.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
"name": "Groups",
1212
"overview": "../../resources/groups-overview.md",
1313
"resources": [
14-
"group"
14+
"group",
15+
"groupLifecyclePolicy"
1516
]
1617
},
1718
{

‎api-reference/v1.0/api/grouplifecyclepolicy-addgroup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "groupLifecyclePolicy: addGroup"
3-
description: "Adds a group to a lifecycle policy."
3+
description: "Add a group to a groupLifecyclePolicy."
44
author: "yuhko-msft"
55
ms.reviewer: "mbhargav, khotzteam, aadgroupssg"
66
ms.localizationpriority: medium
@@ -13,7 +13,7 @@ ms.date: 04/04/2024
1313

1414
Namespace: microsoft.graph
1515

16-
Adds specific groups to a lifecycle policy. This action limits the group lifecycle policy to a set of groups only if the **managedGroupTypes** property of [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md) is set to `Selected`.
16+
Add a group to a [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md). This action is supported only if the **managedGroupTypes** property of the policy is set to `Selected`.
1717

1818
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
1919

@@ -53,7 +53,7 @@ Only one group can be added per request.
5353

5454
## Response
5555

56-
If successful, this method returns `200 OK` response code. If the group is added to the policy, a `true` value is returned in the response body. Otherwise, a `false` value is returned in the response body.
56+
If successful, this method returns `200 OK` response code. If the group is added to the policy, a `true` value is returned in the response body and the **expirationDateTime** property of the added group is set based on the policy's **groupLifetimeInDays** value. Otherwise, a `false` value is returned in the response body.
5757

5858
## Example
5959

‎api-reference/v1.0/api/grouplifecyclepolicy-post-grouplifecyclepolicies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.date: 04/04/2024
1313

1414
Namespace: microsoft.graph
1515

16-
Creates a new [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md).
16+
Creates a new [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md). Only one policy exists in the tenant.
1717

1818
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
1919

@@ -105,7 +105,7 @@ Content-type: application/json
105105

106106
### Response
107107

108-
Note: The response object shown here might be shortened for readability.
108+
>**Note:** The response object shown here might be shortened for readability.
109109
110110
<!-- {
111111
"blockType": "response",

‎api-reference/v1.0/resources/grouplifecyclepolicy.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,17 @@ Represents a lifecycle policy for a Microsoft 365 group. A group lifecycle polic
1818
- Once renewed, the group expiration is extended by the number of days defined in the policy and the group's **expirationDateTime** property defines the new expiration date.
1919
- If the group is not renewed, it expires and is deleted. The group can be restored within a period of 30 days from deletion.
2020

21+
For more information, see [Manage the lifecycle of Microsoft 365 groups in your tenant](/entra/identity/users/groups-lifecycle).
22+
2123
## Methods
2224

2325
| Method | Return Type | Description |
2426
| :--------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :------------------------------------------------------------------ |
25-
| [Get policy](../api/grouplifecyclepolicy-get.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Read properties and relationships of a groupLifecyclePolicy object. |
26-
| [List policies](../api/grouplifecyclepolicy-list.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) collection | List all the groupLifecyclePolicies. |
27-
| [Update policy](../api/grouplifecyclepolicy-update.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Update a groupLifecyclePolicy object. |
28-
| [Delete policy](../api/grouplifecyclepolicy-delete.md) | None | Delete a groupLifecyclePolicy object. |
27+
| [List](../api/grouplifecyclepolicy-list.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) collection | List all the groupLifecyclePolicies. Only one policy exists in the |
28+
|[Create](../api/grouplifecyclepolicy-post-grouplifecyclepolicies.md)|[groupLifecyclePolicy](../resources/grouplifecyclepolicy.md)|Create a new groupLifecyclePolicy object.|
29+
| [Get](../api/grouplifecyclepolicy-get.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Read properties and relationships of a groupLifecyclePolicy object. |
30+
| [Update](../api/grouplifecyclepolicy-update.md) | [groupLifecyclePolicy](grouplifecyclepolicy.md) | Update a groupLifecyclePolicy object. |
31+
| [Delete](../api/grouplifecyclepolicy-delete.md) | None | Delete a groupLifecyclePolicy object. |
2932
| [Add group](../api/grouplifecyclepolicy-addgroup.md) | None | Add a group to a lifecycle policy |
3033
| [Remove group](../api/grouplifecyclepolicy-removegroup.md) | None | Remove a group to a lifecycle policy. |
3134

‎api-reference/v1.0/toc/groups/toc.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,21 @@ items:
198198
href: ../../api/group-unsubscribebymail.md
199199
- name: Reset unseen count
200200
href: ../../api/group-resetunseencount.md
201+
- name: Group lifecycle policy
202+
items:
203+
- name: Group lifecycle policy
204+
href: ../../resources/grouplifecyclepolicy.md
205+
- name: List
206+
href: ../../api/grouplifecyclepolicy-list.md
207+
- name: Create
208+
href: ../../api/grouplifecyclepolicy-post-grouplifecyclepolicies.md
209+
- name: Get
210+
href: ../../api/grouplifecyclepolicy-get.md
211+
- name: Update
212+
href: ../../api/grouplifecyclepolicy-update.md
213+
- name: Delete
214+
href: ../../api/grouplifecyclepolicy-delete.md
215+
- name: Add group
216+
href: ../../api/grouplifecyclepolicy-addgroup.md
217+
- name: Remove group
218+
href: ../../api/grouplifecyclepolicy-removegroup.md

0 commit comments

Comments
 (0)