Create conditionalAccessPolicyRule

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.

Create a new conditionalAccessPolicyRule 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

POST /identity/conditionalAccess/plans/{conditionalAccessPolicyPlanId}/rules

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 a JSON representation of the conditionalAccessPolicyRule object.

You can specify the following properties when creating a conditionalAccessPolicyRule.

Property	Type	Description
conditions	conditionalAccessConditionSet	The conditions specific to the rule. During evaluation, these conditions are combined with the parent plan's sharedConditions property to determine the rule's effective targeting. Optional.
controls	conditionalAccessPolicyRuleControls	The grant and session controls enforced when the rule's effective conditions are met. Required.
description	String	A free-text description of the rule's purpose. Optional.
displayName	String	The administrator-defined display name for the rule. Required.
state	conditionalAccessPolicyState	The state of the rule. The possible values are: enabled, disabled, enabledForReportingButNotEnforced. Required.

Response

If successful, this method returns a 201 Created response code and a conditionalAccessPolicyRule object in the response body.

Examples

Request

The following example shows a request.

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

{
  "displayName": "Require compliant Windows devices",
  "description": "Requires Windows devices to be compliant.",
  "state": "enabled",
  "conditions": {
    "users": {
      "includeUsers": [
        "All"
      ]
    },
    "applications": {
      "includeApplications": [
        "All"
      ]
    }
  },
  "controls": {
    "grantControls": {
      "operator": "OR",
      "builtInControls": [
        "compliantDevice"
      ]
    }
  }
}

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.conditionalAccessPolicyRule",
  "id": "d1e2f3a4-b5c6-7d8e-9f0a-100000000001",
  "displayName": "Require compliant Windows devices",
  "description": "Requires Windows devices to be compliant.",
  "state": "enabled",
  "conditions": {
    "@odata.type": "microsoft.graph.conditionalAccessConditionSet",
    "users": {
      "includeUsers": [
        "All"
      ]
    },
    "applications": {
      "includeApplications": [
        "All"
      ]
    }
  },
  "controls": {
    "@odata.type": "microsoft.graph.conditionalAccessPolicyRuleControls",
    "grantControls": {
      "operator": "OR",
      "builtInControls": [
        "compliantDevice"
      ]
    }
  }
}