Favicon

You are here: Home > API Reference > Apple > Apple Policies > Check policy assignations

Check policy assignations

Required Permission: mdm.apple.policy.get

Retrieves assignation information showing which users, groups, or devices use this policy.

GET
/v1/organizations/:organizationId/mdm/apple/enterprise/policies/:admPolicyId/assignations
Copy to clipboard

Check policy assignations

Required Permission: mdm.apple.policy.get

Retrieves assignation information showing which users, groups, or devices use this policy.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
admPolicyId string
required
Apple device policy unique identifier used in URL path for retrieving or modifying specific policy configuration.
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean optional
data object optional
assigned boolean optional
Flag indicating whether policy is currently assigned to any users groups or devices in organization.
items object optional
Detailed assignation breakdown showing which specific users groups or devices use this policy configuration.
{
    "status": true,
    "data": {
        "assigned": true,
        "items": {}
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}