Create payloadCompatibleAssignmentFilter

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

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

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementConfiguration.ReadWrite.All

HTTP Request

POST /deviceManagement/assignmentFilters

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the payloadCompatibleAssignmentFilter object.

The following table shows the properties that are required when you create the payloadCompatibleAssignmentFilter.

Property	Type	Description
id	String	Key of the Assignment Filter. Inherited from deviceAndAppManagementAssignmentFilter
createdDateTime	DateTimeOffset	The creation time of the assignment filter. The value cannot be modified and is automatically populated during new assignment filter process. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Inherited from deviceAndAppManagementAssignmentFilter
lastModifiedDateTime	DateTimeOffset	Last modified time of the Assignment Filter. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z' Inherited from deviceAndAppManagementAssignmentFilter
displayName	String	The name of the Assignment Filter. Inherited from deviceAndAppManagementAssignmentFilter
description	String	Optional description of the Assignment Filter. Inherited from deviceAndAppManagementAssignmentFilter
platform	devicePlatformType	Indicates filter is applied to which flatform. Possible values are android,androidForWork,iOS,macOS,windowsPhone81,windows81AndLater,windows10AndLater,androidWorkProfile, unknown, androidAOSP, androidMobileApplicationManagement, iOSMobileApplicationManagement, windowsMobileApplicationManagement. Default filter will be applied to 'unknown'. Inherited from deviceAndAppManagementAssignmentFilter. Possible values are: android, androidForWork, iOS, macOS, windowsPhone81, windows81AndLater, windows10AndLater, androidWorkProfile, unknown, androidAOSP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue, windowsMobileApplicationManagement.
rule	String	Rule definition of the assignment filter. Inherited from deviceAndAppManagementAssignmentFilter
roleScopeTags	String collection	Indicates role scope tags assigned for the assignment filter. Inherited from deviceAndAppManagementAssignmentFilter
payloads	payloadByFilter collection	Indicates associated assignments for a specific filter. Inherited from deviceAndAppManagementAssignmentFilter
assignmentFilterManagementType	assignmentFilterManagementType	Indicates filter is applied to either 'devices' or 'apps' management type. Possible values are devices, apps. Default filter will be applied to 'devices' Inherited from deviceAndAppManagementAssignmentFilter. Possible values are: devices, apps, unknownFutureValue.
payloadType	assignmentFilterPayloadType	PayloadType of the Assignment Filter. Possible values are: notSet, enrollmentRestrictions.

Response

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

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceManagement/assignmentFilters
Content-type: application/json
Content-length: 627

{
  "@odata.type": "#microsoft.graph.payloadCompatibleAssignmentFilter",
  "displayName": "Display Name value",
  "description": "Description value",
  "platform": "androidForWork",
  "rule": "Rule value",
  "roleScopeTags": [
    "Role Scope Tags value"
  ],
  "payloads": [
    {
      "@odata.type": "microsoft.graph.payloadByFilter",
      "payloadId": "Payload Id value",
      "payloadType": "deviceConfigurationAndCompliance",
      "groupId": "Group Id value",
      "assignmentFilterType": "include"
    }
  ],
  "assignmentFilterManagementType": "apps",
  "payloadType": "enrollmentRestrictions"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.payloadCompatibleAssignmentFilter",
  "id": "6d189738-9738-6d18-3897-186d3897186d",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "displayName": "Display Name value",
  "description": "Description value",
  "platform": "androidForWork",
  "rule": "Rule value",
  "roleScopeTags": [
    "Role Scope Tags value"
  ],
  "payloads": [
    {
      "@odata.type": "microsoft.graph.payloadByFilter",
      "payloadId": "Payload Id value",
      "payloadType": "deviceConfigurationAndCompliance",
      "groupId": "Group Id value",
      "assignmentFilterType": "include"
    }
  ],
  "assignmentFilterManagementType": "apps",
  "payloadType": "enrollmentRestrictions"
}