Create policy assignment
Relative path: /v2/policy-assignments
Assignments to the same targets are ordered and prioritized.
Every new assignment to the target is put at the end of the stack. Assignment ranking would be equal to number of target's assignments.
Ranking 1 is the highest and policies are merged from the rank 1 towards lower ranks.
info Similar concept is described in https://learn.microsoft.com/en-us/microsoftteams/assign-policies-users-and-groups#group-assignment-ranking
Request body
Display Schema instead of an Example or vice-versa
Type |
Required |
Example |
Schema |
|---|---|---|---|
application/json |
No |
{
"assignment": {
"policyUuid": "string",
"rank": 0,
"target": {
"deviceUuid": "string",
"deviceGroupUuid": "string",
"subscriptionUuid": "string"
},
"uuid": "string"
}
} |
{
"$ref": "v2AssignPolicyRequest",
"assignment": {
"$ref": "v2PolicyAssignment",
"description": "Relation between policy and target. One target can have multiple policies assigned. Those policies are",
"policyUuid": {
"type": "string",
"description": "Assigned policy. type: Policy"
},
"rank": {
"type": "integer",
"description": "Ranking within multiple assignments to the target. Rank 1 is the highest rank, i.e. the rank of highest priority. Policies are applied in order from the highest rank to the lowest. EP(c) migration note This attribute was called priority in ERA/ESMC/EP(c). This, however, lead to counterintuitive behavior of highest priority with lowest number.",
"format": "int64"
},
"target": {
"$ref": "v2PolicyTarget",
"description": "Identifies entity to which the policy is assigned.",
"deviceUuid": {
"type": "string",
"description": "Policy is assigned to [device]. type: device_management.v1.Device"
},
"deviceGroupUuid": {
"type": "string",
"description": "Policy is assigned to [device group]. type: device_management.v1.DeviceGroup"
},
"subscriptionUuid": {
"type": "string",
"description": "Police is assigned to [subscription]. type: subscription_provisioning.v2.Subscription"
}
},
"uuid": {
"type": "string",
"description": "Universally Unique Identifier References use this identifier so it must be filled in all the cases except resource creation. Compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace Formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. For example: '123e4567-e89b-12d3-a456-426614174000'"
}
}
} |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
|---|---|---|---|
200 |
Successful response. |
{
"assignment": {
"policyUuid": "string",
"rank": 0,
"target": {
"deviceUuid": "string",
"deviceGroupUuid": "string",
"subscriptionUuid": "string"
},
"uuid": "string"
}
} |
{
"$ref": "v2AssignPolicyResponse",
"assignment": {
"$ref": "v2PolicyAssignment",
"description": "Relation between policy and target. One target can have multiple policies assigned. Those policies are",
"policyUuid": {
"type": "string",
"description": "Assigned policy. type: Policy"
},
"rank": {
"type": "integer",
"description": "Ranking within multiple assignments to the target. Rank 1 is the highest rank, i.e. the rank of highest priority. Policies are applied in order from the highest rank to the lowest. EP(c) migration note This attribute was called priority in ERA/ESMC/EP(c). This, however, lead to counterintuitive behavior of highest priority with lowest number.",
"format": "int64"
},
"target": {
"$ref": "v2PolicyTarget",
"description": "Identifies entity to which the policy is assigned.",
"deviceUuid": {
"type": "string",
"description": "Policy is assigned to [device]. type: device_management.v1.Device"
},
"deviceGroupUuid": {
"type": "string",
"description": "Policy is assigned to [device group]. type: device_management.v1.DeviceGroup"
},
"subscriptionUuid": {
"type": "string",
"description": "Police is assigned to [subscription]. type: subscription_provisioning.v2.Subscription"
}
},
"uuid": {
"type": "string",
"description": "Universally Unique Identifier References use this identifier so it must be filled in all the cases except resource creation. Compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace Formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. For example: '123e4567-e89b-12d3-a456-426614174000'"
}
}
} |
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
null |
[] |
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
null |
[] |
401 |
Token has expired or is invalid. |
null |
[] |
403 |
Access denied. Check permissions. |
null |
[] |
404 |
Requested resource not found. |
null |
[] |
429 |
Rate limit reached. Try again later. |
null |
[] |
500 |
Internal server failure. Try again later. |
null |
[] |
502 |
Internal server failure. Try again later. |
null |
[] |
503 |
Environment under maintenance. Try again later. |
null |
[] |
504 |
Action took too long; timeout reached |
null |
[] |