Upravit

Sdílet prostřednictvím


Update groupLifecyclePolicy

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a groupLifecyclePolicygroupLifecyclePolicy resource type object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Directory.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Directory.ReadWrite.All Not available.

HTTP request

PATCH /groupLifecyclePolicies/{id}

Optional request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Property Type Description
alternateNotificationEmails String List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
groupLifetimeInDays Int32 Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.
managedGroupTypes String The group type for which the expiration policy applies. Possible values are All, Selected or None.

Response

If successful, this method returns a 200 OK response code and updated groupLifecyclePolicy object in the response body.

Example

Request
PATCH https://graph.microsoft.com/beta/groupLifecyclePolicies/{id}
Content-type: application/json

{
  "groupLifetimeInDays": 180,
  "managedGroupTypes": "Selected",
  "alternateNotificationEmails": "admin@contoso.com"
}
Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "id-value",
  "groupLifetimeInDays": 180,
  "managedGroupTypes": "Selected",
  "alternateNotificationEmails": "admin@contoso.com"
}