Edit

Update conditionalAccessPolicyPlan

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 conditionalAccessPolicyPlan object.

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 permission Higher privileged permissions
Delegated (work or school account) Policy.ReadWrite.ConditionalAccess Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.ReadWrite.ConditionalAccess Not available.

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. Conditional Access Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /identity/conditionalAccess/plans/{conditionalAccessPolicyPlanId}

Request headers

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

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
description String A free-text description of the plan's purpose and scope.
displayName String The administrator-defined display name for the plan.
owners String collection The IDs of users and groups recorded as metadata owners of the plan. Does not grant any role or permission to the plan.
sharedConditions conditionalAccessConditionSet The conditions that apply to every rule in the plan. During evaluation, these conditions are combined with each rule's conditions property; rules can add conditions but can't remove plan-level conditions.
tags String collection The administrator-defined tags used to categorize and organize the plan.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/identity/conditionalAccess/plans/d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a
Content-Type: application/json

{
  "description": "Requires compliant devices for employees and contractors.",
  "sharedConditions": {
    "platforms": {
      "includePlatforms": [
        "windows"
      ]
    }
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content