Favicon

You are here: Home > API Reference > Apple > Apple Devices > Update admDevice

PUT /organizations/:organizationId/mdm/apple/enterprise/devices/:admDeviceId

Required Permission: mdm.apple.device.update

Update admDevice

PUT
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/devices/{admDeviceId} 
curl -X PUT "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/devices/{admDeviceId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "string",
  "tags": [
    "string"
  ],
  "policyId": "string",
  "admPolicyAssignments": [
    {}
  ],
  "admVppLocationId": "string",
  "profiles": [
    "string"
  ],
  "applications": [
    {}
  ],
  "books": [
    {}
  ],
  "scripts": [
    {}
  ],
  "mdmUserId": "string",
  "skipPersonalInfo": true,
  "smartAttributeAssignments": [
    {}
  ],
  "segmentId": 0
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/devices/{admDeviceId}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "displayName": "string",
    "tags": [
      "string"
    ],
    "policyId": "string",
    "admPolicyAssignments": [
      {}
    ],
    "admVppLocationId": "string",
    "profiles": [
      "string"
    ],
    "applications": [
      {}
    ],
    "books": [
      {}
    ],
    "scripts": [
      {}
    ],
    "mdmUserId": "string",
    "skipPersonalInfo": true,
    "smartAttributeAssignments": [
      {}
    ],
    "segmentId": 0
  }),
});

const data = await response.json();
import requests

response = requests.put(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/devices/{admDeviceId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "displayName": "string",
      "tags": [
        "string"
      ],
      "policyId": "string",
      "admPolicyAssignments": [
        {}
      ],
      "admVppLocationId": "string",
      "profiles": [
        "string"
      ],
      "applications": [
        {}
      ],
      "books": [
        {}
      ],
      "scripts": [
        {}
      ],
      "mdmUserId": "string",
      "skipPersonalInfo": true,
      "smartAttributeAssignments": [
        {}
      ],
      "segmentId": 0
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
admDeviceId string
required
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$

Body Params application/json
displayName string optional
≤ 128 characters
tags array [string] optional
policyId string optional
Match pattern: ^[a-fA-F0-9]{24}$
admPolicyAssignments array [object] optional
admPolicyId string optional
Match pattern: ^[a-fA-F0-9]{24}$
priority integer required
≥ 0 · ≤ 10000
admVppLocationId string optional
Match pattern: ^[a-fA-F0-9]{24}$
profiles array [string] optional
applications array [object] optional
admApplication string required
Apple application assignment target referencing the admApplication entity to install or expose on the device, policy, or enrollment token.
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
Controls Apple managed-install semantics for this app assignment. This field still drives InstallAsManaged and ChangeManagementState.
managementFlags number optional
Optional Apple MDM InstallApplication.ManagementFlags override for this app assignment. Supported values are 1 (remove app when the MDM profile is removed), 4 (prevent backup of app documents and data), and 5 (both behaviors). If omitted, backend behavior stays unchanged: managed=true sends 5; otherwise the field is omitted. This field only overrides Apple ManagementFlags and does not imply managed=true.
Format: float
0 1 4 5
vpp boolean optional
Enables Apple Volume Purchase Program purchase handling for this assignment when the app should be installed through VPP licensing.
iOSApp boolean optional
Apple InstallApplication iOSApp flag passed for this assignment when the target app should be treated as an iOS app payload.
configuration object optional
Managed app configuration object sent with the Apple app assignment when the application supports configuration keys.
action string optional
Assignment action defining whether the app is force-installed, available for optional install, or required during setup.
forceInstall available requiredForSetup
actionStatus string optional
Read-only effective assignment status shown in responses. Devices may report available assignments as either available or available-install depending on the device request state.
forceInstall available requiredForSetup available-install
scripts object optional
Optional agent-side install lifecycle scripts associated with this assignment for Apple agent-managed application flows.
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatePolicy object optional
Additional update-policy configuration stored with the app assignment for downstream deployment or agent-handled behaviors.
books array [object] optional
type string optional
asset store
id string optional
≤ 128 characters
scripts array [object] optional
id string optional
≤ 128 characters
type string optional
once loop onDemand
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scope string optional
user machine
mdmUserId string optional
Match pattern: ^[a-fA-F0-9]{24}$
skipPersonalInfo boolean optional
smartAttributeAssignments array [object] optional
smartAttributeId string required
Match pattern: ^[a-fA-F0-9]{24}$
segmentId integer optional
≥ 0
{
    "displayName": "string",
    "tags": [
        "string"
    ],
    "policyId": "string",
    "admPolicyAssignments": [
        {
            "admPolicyId": "string",
            "priority": 0
        }
    ],
    "admVppLocationId": "string",
    "profiles": [
        "string"
    ],
    "applications": [
        {
            "admApplication": "698f42e5457fafa13d088794",
            "managed": true,
            "managementFlags": 5,
            "vpp": true,
            "iOSApp": true,
            "configuration": {},
            "action": "forceInstall",
            "actionStatus": "forceInstall",
            "scripts": {},
            "updatePolicy": {}
        }
    ],
    "books": [
        {
            "type": "asset",
            "id": "string"
        }
    ],
    "scripts": [
        {
            "id": "string",
            "type": "once",
            "loopTime": 0,
            "resetDate": "2024-01-01T00: 00:00Z",
            "arguments": "string",
            "argumentsProcessed": "string",
            "name": "string",
            "description": "string",
            "runner": "string",
            "scope": "user"
        }
    ],
    "mdmUserId": "string",
    "skipPersonalInfo": true,
    "smartAttributeAssignments": [
        {
            "smartAttributeId": "string"
        }
    ],
    "segmentId": 0
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Match pattern: ^[a-fA-F0-9]{24}$
mdmUser object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
≤ 128 characters
displayName string optional
≤ 128 characters
tags array [string] optional
state string optional
PROVISIONING ACTIVE DELETED UNKNOWN EXPIRED PENDING
config object optional
configDates object optional
info object optional
enroll object optional
serverExpirationDate string optional
Format: date-time
mobileConfigSigned boolean optional
control object optional
UDID string optional
≤ 256 characters
authenticatedDate string optional
Format: date-time
topic string optional
≤ 256 characters
deletedDate string optional
Format: date-time
lastTokenUpdateDate string optional
Format: date-time
pushMagic string optional
≤ 256 characters
token string optional
≤ 256 characters
unlockToken string optional
≤ 256 characters
bootstrapToken string optional
≤ 256 characters
skipPersonalInfo boolean optional
summary object optional
name string optional
≤ 256 characters
osVersion string optional
≤ 128 characters
os string optional
≤ 128 characters
serialNumber string optional
≤ 128 characters
imei string optional
≤ 128 characters
battery string optional
≤ 128 characters
expirationTimestamp string optional
Format: date-time
supervised boolean optional
image string optional
≤ 128 characters
compliance object optional
manufacturer string optional
≤ 128 characters
model string optional
≤ 128 characters
udid string optional
≤ 128 characters
hostname string optional
≤ 128 characters
ipAddress string optional
≤ 128 characters
macAddress string optional
≤ 128 characters
smartAttributeAssignments array [object] optional
smartAttributeId string optional
Match pattern: ^[a-fA-F0-9]{24}$
smartAttribute object optional
smartAttributeAssignmentsEnforced array [object] optional
smartAttributeId string optional
Match pattern: ^[a-fA-F0-9]{24}$
smartAttribute object optional
smartAttributes array [object] optional
id string required
Match pattern: ^[a-fA-F0-9]{24}$
type string optional
constant enum manual selector script
label string optional
≤ 256 characters
value string required
updatedAt string required
Format: date-time
lastStatusReportTime string optional
Format: date-time
type string optional
≤ 128 characters
subType string optional
≤ 128 characters
enrollmentLink string optional
≤ 500 characters
enrollCode string optional
≤ 128 characters
admPolicy object optional
id string optional
Unique Apple device policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Organization identifier owning this Apple device policy and managing enrolled iOS iPadOS and macOS devices.
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Apple enterprise account identifier linked to Apple Business Manager or Apple School Manager for device management.
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
Policy application scope defining whether configurations apply to entire device or device user context only.
device deviceUser
attachedProfile object optional
Automatically attached configuration profile containing essential MDM settings applied independently of policy assignments and priorities.
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 256 characters
profiles array [object] optional
List of Apple configuration profiles containing device restrictions security settings and feature configurations applied by policy.
applications array [object] optional
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
applicationsInfo array [object] optional
Enriched application metadata including app names icons versions and store information for dashboard display purposes.
books array [object] optional
List of book assignments for distributing VPP-purchased books or PDF documents to managed Apple devices.
booksInfo array [object] optional
Enriched book metadata including titles authors cover images and store information for dashboard display purposes.
scripts array [object] optional
List of script assignments for executing automated tasks compliance checks and configuration enforcement on macOS devices.
scriptsInfo array [object] optional
Enriched script metadata including execution history last run timestamps and success rates for monitoring purposes.
bookmarks array [object] optional
List of bookmark assignments for deploying web application shortcuts and internal portal links to device home screens.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
version integer optional
Policy version number incremented with each modification for tracking configuration changes and rollback capabilities.
≥ 0
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
Format: date-time
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
Format: date-time
agentConfiguration object optional
MDM agent behavior settings controlling location tracking app monitoring data collection and application enforcement actions.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
exposeToChildren boolean optional
deviceAdmPolicy object optional
id string optional
Unique Apple device policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Organization identifier owning this Apple device policy and managing enrolled iOS iPadOS and macOS devices.
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Apple enterprise account identifier linked to Apple Business Manager or Apple School Manager for device management.
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
Policy application scope defining whether configurations apply to entire device or device user context only.
device deviceUser
attachedProfile object optional
Automatically attached configuration profile containing essential MDM settings applied independently of policy assignments and priorities.
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 256 characters
profiles array [object] optional
List of Apple configuration profiles containing device restrictions security settings and feature configurations applied by policy.
applications array [object] optional
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
applicationsInfo array [object] optional
Enriched application metadata including app names icons versions and store information for dashboard display purposes.
books array [object] optional
List of book assignments for distributing VPP-purchased books or PDF documents to managed Apple devices.
booksInfo array [object] optional
Enriched book metadata including titles authors cover images and store information for dashboard display purposes.
scripts array [object] optional
List of script assignments for executing automated tasks compliance checks and configuration enforcement on macOS devices.
scriptsInfo array [object] optional
Enriched script metadata including execution history last run timestamps and success rates for monitoring purposes.
bookmarks array [object] optional
List of bookmark assignments for deploying web application shortcuts and internal portal links to device home screens.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
version integer optional
Policy version number incremented with each modification for tracking configuration changes and rollback capabilities.
≥ 0
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
Format: date-time
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
Format: date-time
agentConfiguration object optional
MDM agent behavior settings controlling location tracking app monitoring data collection and application enforcement actions.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
exposeToChildren boolean optional
admPolicyAssignments array [object] optional
admPolicyId string optional
Apple policy unique identifier for assignment tracking and API operations in policy composition workflows.
Match pattern: ^[a-fA-F0-9]{24}$
admPolicy object optional
Complete Apple Device Management policy object containing configuration profiles, restrictions, and app deployment settings.
priority integer optional
Policy assignment priority determining precedence when multiple policies apply to device for conflict resolution.
≥ 0
admPolicyAssignmentsEnforced array [object] optional
admPolicyId string optional
Apple policy unique identifier for assignment tracking and API operations in policy composition workflows.
Match pattern: ^[a-fA-F0-9]{24}$
admPolicy object optional
Complete Apple Device Management policy object containing configuration profiles, restrictions, and app deployment settings.
priority integer optional
Policy assignment priority determining precedence when multiple policies apply to device for conflict resolution.
≥ 0
automationRule object optional
Automation rule object documenting which rule triggered policy assignment for audit trails and compliance reports.
admVppLocation object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
profiles array [object] optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Match pattern: ^[a-fA-F0-9]{24}$
admPolicy string optional
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
device deviceUser
name string optional
≤ 256 characters
config object optional
certificates array [object] optional
type string optional
attached single
UUID string optional
≤ 128 characters
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
assignedTo object optional
useCustomFileVaultCertificates boolean optional
parentAdmProfileId string optional
Match pattern: ^[a-fA-F0-9]{24}$
applications array [object] optional
admApplication string required
Apple application assignment target referencing the admApplication entity to install or expose on the device, policy, or enrollment token.
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
Controls Apple managed-install semantics for this app assignment. This field still drives InstallAsManaged and ChangeManagementState.
managementFlags number optional
Optional Apple MDM InstallApplication.ManagementFlags override for this app assignment. Supported values are 1 (remove app when the MDM profile is removed), 4 (prevent backup of app documents and data), and 5 (both behaviors). If omitted, backend behavior stays unchanged: managed=true sends 5; otherwise the field is omitted. This field only overrides Apple ManagementFlags and does not imply managed=true.
Format: float
0 1 4 5
vpp boolean optional
Enables Apple Volume Purchase Program purchase handling for this assignment when the app should be installed through VPP licensing.
iOSApp boolean optional
Apple InstallApplication iOSApp flag passed for this assignment when the target app should be treated as an iOS app payload.
configuration object optional
Managed app configuration object sent with the Apple app assignment when the application supports configuration keys.
action string optional
Assignment action defining whether the app is force-installed, available for optional install, or required during setup.
forceInstall available requiredForSetup
actionStatus string optional
Read-only effective assignment status shown in responses. Devices may report available assignments as either available or available-install depending on the device request state.
forceInstall available requiredForSetup available-install
scripts object optional
Optional agent-side install lifecycle scripts associated with this assignment for Apple agent-managed application flows.
updatePolicy object optional
Additional update-policy configuration stored with the app assignment for downstream deployment or agent-handled behaviors.
books array [object] optional
type string optional
asset store
id string optional
≤ 128 characters
booksInfo array [object] optional
scripts array [object] optional
id string optional
≤ 128 characters
type string optional
once loop onDemand
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scope string optional
user machine
scriptsInfo array [object] optional
stateHistory array [object] optional
state string optional
PROVISIONING ACTIVE DELETED UNKNOWN EXPIRED PENDING
date string optional
Format: date-time
config object optional
applicationsInfo array [object] optional
isDepDevice boolean optional
admDepDevice string optional
Match pattern: ^[a-fA-F0-9]{24}$
lastLocation object optional
agent object optional
ip object optional
counts object optional
users integer optional
≥ 0
lastReports object optional
sync string optional
Format: date-time
agent object optional
enrolledDate string optional
Format: date-time
hasActivationBypassCode boolean optional
hasFileVaultRecoveryKey boolean optional
hasFileVaultRecoveryKeyEncrypted boolean optional
admDeviceUsers array [object] optional
pushNotifications object optional
mdmAgent boolean optional
setupAssistant boolean optional
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
segmentId integer optional
≥ 0
devicePolicyStatus object optional
pushed boolean optional
audit array [object] optional 
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "admEnterprise": "string",
        "mdmUser": {
            "id": "string",
            "email": "string"
        },
        "displayName": "string",
        "tags": [
            "string"
        ],
        "state": "PROVISIONING",
        "config": {},
        "configDates": {},
        "info": {},
        "enroll": {
            "serverExpirationDate": "2024-01-01T00: 00:00Z",
            "mobileConfigSigned": true
        },
        "control": {
            "UDID": "string",
            "authenticatedDate": "2024-01-01T00: 00:00Z",
            "topic": "string",
            "deletedDate": "2024-01-01T00: 00:00Z",
            "lastTokenUpdateDate": "2024-01-01T00: 00:00Z",
            "pushMagic": "string",
            "token": "string",
            "unlockToken": "string",
            "bootstrapToken": "string",
            "skipPersonalInfo": true
        },
        "summary": {
            "name": "string",
            "osVersion": "string",
            "os": "string",
            "serialNumber": "string",
            "imei": "string",
            "battery": "string",
            "expirationTimestamp": "2024-01-01T00: 00:00Z",
            "supervised": true,
            "image": "string",
            "compliance": {},
            "manufacturer": "string",
            "model": "string",
            "udid": "string",
            "hostname": "string",
            "ipAddress": "string",
            "macAddress": "string"
        },
        "smartAttributeAssignments": [
            {
                "smartAttributeId": "string",
                "smartAttribute": {
                    "id": "string",
                    "organizationId": "string",
                    "segmentId": 0,
                    "exposeToChildren": true,
                    "name": "string",
                    "description": "string",
                    "output": {
                        "type": "string"
                    },
                    "input": {
                        "type": "constant",
                        "value": {
                            "admDevice": {
                                "value": "string"
                            },
                            "aosDevice": {
                                "value": "string"
                            },
                            "emmDevice": {
                                "value": "string"
                            },
                            "winDevice": {
                                "value": "string"
                            }
                        },
                        "source": "constant"
                    },
                    "counts": {
                        "android": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        },
                        "apple": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        },
                        "windows": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        }
                    }
                }
            }
        ],
        "smartAttributeAssignmentsEnforced": [
            {
                "smartAttributeId": "string",
                "smartAttribute": {
                    "id": "string",
                    "organizationId": "string",
                    "segmentId": 0,
                    "exposeToChildren": true,
                    "name": "string",
                    "description": "string",
                    "output": {
                        "type": "string"
                    },
                    "input": {
                        "type": "constant",
                        "value": {
                            "admDevice": {
                                "value": "string"
                            },
                            "aosDevice": {
                                "value": "string"
                            },
                            "emmDevice": {
                                "value": "string"
                            },
                            "winDevice": {
                                "value": "string"
                            }
                        },
                        "source": "constant"
                    },
                    "counts": {
                        "android": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        },
                        "apple": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        },
                        "windows": {
                            "smartAttributeAssignments": 0,
                            "smartAttributeAssignmentsEnforced": 0
                        }
                    }
                }
            }
        ],
        "smartAttributes": [
            {
                "id": "string",
                "type": "constant",
                "label": "string",
                "value": "string",
                "updatedAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "lastStatusReportTime": "2024-01-01T00: 00:00Z",
        "type": "string",
        "subType": "string",
        "enrollmentLink": "string",
        "enrollCode": "string",
        "admPolicy": {
            "id": "698f41b2457fafa13d088793",
            "organization": "598f469d457fafa13d088795",
            "admEnterprise": "698f42e5457fafa13d088794",
            "targetType": "device",
            "attachedProfile": {},
            "name": "Corporate Security Policy - iOS",
            "profiles": [
                {
                    "id": "string",
                    "organization": "string",
                    "admEnterprise": "string",
                    "admPolicy": "string",
                    "targetType": "device",
                    "name": "string",
                    "config": {},
                    "certificates": [
                        {
                            "mdmAssetId": "string",
                            "format": {
                                "uuid": "uuid",
                                "base64": "base64"
                            },
                            "location": "string",
                            "password": "string",
                            "allowAllAppsAccess": true,
                            "keyIsExtractable": true
                        }
                    ],
                    "type": "attached",
                    "UUID": "string",
                    "version": 0,
                    "updatedAt": "2024-01-01T00: 00:00Z",
                    "createdAt": "2024-01-01T00: 00:00Z",
                    "assignedTo": {
                        "policies": [
                            {
                                "id": "string",
                                "name": "string"
                            }
                        ],
                        "devices": [
                            {
                                "id": "string",
                                "displayName": "string"
                            }
                        ]
                    },
                    "useCustomFileVaultCertificates": true,
                    "parentAdmProfileId": "string"
                }
            ],
            "applications": [
                {
                    "admApplication": "698f42e5457fafa13d088794",
                    "managed": true,
                    "managementFlags": 5,
                    "vpp": true,
                    "iOSApp": true,
                    "configuration": {},
                    "action": "forceInstall",
                    "actionStatus": "forceInstall",
                    "scripts": {},
                    "updatePolicy": {}
                }
            ],
            "applicationsInfo": [
                {}
            ],
            "books": [
                {
                    "type": "asset",
                    "id": "698f42e5457fafa13d088794"
                }
            ],
            "booksInfo": [
                {}
            ],
            "scripts": [
                {
                    "type": "loop",
                    "id": "698f42e5457fafa13d088794",
                    "loopTime": 3600,
                    "arguments": "--verbose --check-compliance",
                    "name": "Security Compliance Check",
                    "description": "Validates device security posture against organizational standards",
                    "runner": "bash"
                }
            ],
            "scriptsInfo": [
                {}
            ],
            "bookmarks": [
                {
                    "title": "Employee Portal",
                    "description": "Internal employee self-service portal",
                    "url": "https://portal.company.com",
                    "iconBase64": "",
                    "iconUrl": "https://portal.company.com/icon.png"
                }
            ],
            "assets": [
                {
                    "mdmAssetId": "698f41b2457fafa13d088793",
                    "location": "/Library/Application Support/Company/config.json",
                    "assetName": "App Configuration",
                    "scope": "system"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "version": 3,
            "updatedAt": "2026-02-13T14: 30:00Z",
            "createdAt": "2026-02-13T10: 00:00Z",
            "agentConfiguration": {
                "allowLocation": true,
                "allowLocationMacos": true,
                "allowPackageTime": true,
                "allowPackageTimeIos": true,
                "allowPackageTransfer": true,
                "allowPackageTransferIos": true,
                "allowDeviceInfoBatteryUsage": true,
                "allowDeviceInfoBluetooth": true,
                "allowDeviceInfoSystemInfo": true,
                "allowDeviceInfoBatteryUsageIos": true,
                "allowDeviceInfoBluetoothIos": true,
                "allowDeviceInfoSystemInfoIos": true,
                "allowNetworkStatusMacos": true,
                "allowNetworkStatusIos": true,
                "appBlacklist": [
                    {
                        "bundleId": "com.example.unauthorized",
                        "action": "block"
                    }
                ],
                "policyFeatures": {
                    "ios": {
                        "defaultViewFeature": "applications",
                        "toggledFeatures": [
                            {
                                "name": "applications",
                                "active": true
                            }
                        ],
                        "enableDefaultView": true
                    },
                    "macos": {
                        "defaultViewFeature": "applications",
                        "toggledFeatures": [
                            {
                                "name": "applications",
                                "active": true
                            }
                        ],
                        "enableDefaultView": true
                    }
                }
            },
            "segmentId": "1",
            "exposeToChildren": true
        },
        "deviceAdmPolicy": {
            "id": "698f41b2457fafa13d088793",
            "organization": "598f469d457fafa13d088795",
            "admEnterprise": "698f42e5457fafa13d088794",
            "targetType": "device",
            "attachedProfile": {},
            "name": "Corporate Security Policy - iOS",
            "profiles": [
                {
                    "id": "string",
                    "organization": "string",
                    "admEnterprise": "string",
                    "admPolicy": "string",
                    "targetType": "device",
                    "name": "string",
                    "config": {},
                    "certificates": [
                        {
                            "mdmAssetId": "string",
                            "format": {
                                "uuid": "uuid",
                                "base64": "base64"
                            },
                            "location": "string",
                            "password": "string",
                            "allowAllAppsAccess": true,
                            "keyIsExtractable": true
                        }
                    ],
                    "type": "attached",
                    "UUID": "string",
                    "version": 0,
                    "updatedAt": "2024-01-01T00: 00:00Z",
                    "createdAt": "2024-01-01T00: 00:00Z",
                    "assignedTo": {
                        "policies": [
                            {
                                "id": "string",
                                "name": "string"
                            }
                        ],
                        "devices": [
                            {
                                "id": "string",
                                "displayName": "string"
                            }
                        ]
                    },
                    "useCustomFileVaultCertificates": true,
                    "parentAdmProfileId": "string"
                }
            ],
            "applications": [
                {
                    "admApplication": "698f42e5457fafa13d088794",
                    "managed": true,
                    "managementFlags": 5,
                    "vpp": true,
                    "iOSApp": true,
                    "configuration": {},
                    "action": "forceInstall",
                    "actionStatus": "forceInstall",
                    "scripts": {},
                    "updatePolicy": {}
                }
            ],
            "applicationsInfo": [
                {}
            ],
            "books": [
                {
                    "type": "asset",
                    "id": "698f42e5457fafa13d088794"
                }
            ],
            "booksInfo": [
                {}
            ],
            "scripts": [
                {
                    "type": "loop",
                    "id": "698f42e5457fafa13d088794",
                    "loopTime": 3600,
                    "arguments": "--verbose --check-compliance",
                    "name": "Security Compliance Check",
                    "description": "Validates device security posture against organizational standards",
                    "runner": "bash"
                }
            ],
            "scriptsInfo": [
                {}
            ],
            "bookmarks": [
                {
                    "title": "Employee Portal",
                    "description": "Internal employee self-service portal",
                    "url": "https://portal.company.com",
                    "iconBase64": "",
                    "iconUrl": "https://portal.company.com/icon.png"
                }
            ],
            "assets": [
                {
                    "mdmAssetId": "698f41b2457fafa13d088793",
                    "location": "/Library/Application Support/Company/config.json",
                    "assetName": "App Configuration",
                    "scope": "system"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "version": 3,
            "updatedAt": "2026-02-13T14: 30:00Z",
            "createdAt": "2026-02-13T10: 00:00Z",
            "agentConfiguration": {
                "allowLocation": true,
                "allowLocationMacos": true,
                "allowPackageTime": true,
                "allowPackageTimeIos": true,
                "allowPackageTransfer": true,
                "allowPackageTransferIos": true,
                "allowDeviceInfoBatteryUsage": true,
                "allowDeviceInfoBluetooth": true,
                "allowDeviceInfoSystemInfo": true,
                "allowDeviceInfoBatteryUsageIos": true,
                "allowDeviceInfoBluetoothIos": true,
                "allowDeviceInfoSystemInfoIos": true,
                "allowNetworkStatusMacos": true,
                "allowNetworkStatusIos": true,
                "appBlacklist": [
                    {
                        "bundleId": "com.example.unauthorized",
                        "action": "block"
                    }
                ],
                "policyFeatures": {
                    "ios": {
                        "defaultViewFeature": "applications",
                        "toggledFeatures": [
                            {
                                "name": "applications",
                                "active": true
                            }
                        ],
                        "enableDefaultView": true
                    },
                    "macos": {
                        "defaultViewFeature": "applications",
                        "toggledFeatures": [
                            {
                                "name": "applications",
                                "active": true
                            }
                        ],
                        "enableDefaultView": true
                    }
                }
            },
            "segmentId": "1",
            "exposeToChildren": true
        },
        "admPolicyAssignments": [
            {
                "admPolicyId": "698f42e5457fafa13d08879c",
                "admPolicy": {},
                "priority": 1
            }
        ],
        "admPolicyAssignmentsEnforced": [
            {
                "admPolicyId": "698f42e5457fafa13d08879c",
                "admPolicy": {},
                "priority": 1,
                "automationRule": {
                    "id": "698f42e5457fafa13d08879d",
                    "name": "Sales Team iOS Policies",
                    "deviceAudiences": [
                        {
                            "id": "698f42e5457fafa13d0887a7",
                            "name": "Sales Department",
                            "reasons": [
                                "tag:sales",
                                "user.department:Sales"
                            ]
                        }
                    ]
                }
            }
        ],
        "admVppLocation": {
            "id": "string",
            "name": "string",
            "config": {
                "countryISO2ACode": "string",
                "defaultPlatform": "string",
                "locationName": "string"
            }
        },
        "profiles": [
            {
                "id": "string",
                "organization": "string",
                "admEnterprise": "string",
                "admPolicy": "string",
                "targetType": "device",
                "name": "string",
                "config": {},
                "certificates": [
                    {
                        "mdmAssetId": "string",
                        "format": {
                            "uuid": "uuid",
                            "base64": "base64"
                        },
                        "location": "string",
                        "password": "string",
                        "allowAllAppsAccess": true,
                        "keyIsExtractable": true
                    }
                ],
                "type": "attached",
                "UUID": "string",
                "version": 0,
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z",
                "assignedTo": {
                    "policies": [
                        {
                            "id": "string",
                            "name": "string"
                        }
                    ],
                    "devices": [
                        {
                            "id": "string",
                            "displayName": "string"
                        }
                    ]
                },
                "useCustomFileVaultCertificates": true,
                "parentAdmProfileId": "string"
            }
        ],
        "applications": [
            {
                "admApplication": "698f42e5457fafa13d088794",
                "managed": true,
                "managementFlags": 5,
                "vpp": true,
                "iOSApp": true,
                "configuration": {},
                "action": "forceInstall",
                "actionStatus": "forceInstall",
                "scripts": {},
                "updatePolicy": {}
            }
        ],
        "books": [
            {
                "type": "asset",
                "id": "string"
            }
        ],
        "booksInfo": [
            {}
        ],
        "scripts": [
            {
                "id": "string",
                "type": "once",
                "loopTime": 0,
                "resetDate": "2024-01-01T00: 00:00Z",
                "arguments": "string",
                "argumentsProcessed": "string",
                "name": "string",
                "description": "string",
                "runner": "string",
                "scope": "user"
            }
        ],
        "scriptsInfo": [
            {}
        ],
        "stateHistory": [
            {
                "state": "PROVISIONING",
                "date": "2024-01-01T00: 00:00Z",
                "config": {}
            }
        ],
        "applicationsInfo": [
            {}
        ],
        "isDepDevice": true,
        "admDepDevice": "string",
        "lastLocation": {
            "agent": {
                "origin": "agent",
                "date": "2024-01-01T00: 00:00Z",
                "latitude": 0,
                "longitude": 0,
                "ip": "string",
                "lastReportDate": "2024-01-01T00: 00:00Z",
                "address": {
                    "address": "string",
                    "number": "string",
                    "postalCode": "string",
                    "city": "string",
                    "country": "string"
                }
            },
            "ip": {
                "origin": "agent",
                "date": "2024-01-01T00: 00:00Z",
                "latitude": 0,
                "longitude": 0,
                "ip": "string",
                "lastReportDate": "2024-01-01T00: 00:00Z",
                "address": {
                    "address": "string",
                    "number": "string",
                    "postalCode": "string",
                    "city": "string",
                    "country": "string"
                }
            }
        },
        "counts": {
            "users": 0
        },
        "lastReports": {
            "sync": "2024-01-01T00: 00:00Z",
            "agent": {
                "location": "2024-01-01T00: 00:00Z",
                "packageTime": "2024-01-01T00: 00:00Z",
                "packageTransfer": "2024-01-01T00: 00:00Z"
            }
        },
        "enrolledDate": "2024-01-01T00: 00:00Z",
        "hasActivationBypassCode": true,
        "hasFileVaultRecoveryKey": true,
        "hasFileVaultRecoveryKeyEncrypted": true,
        "admDeviceUsers": [
            {}
        ],
        "pushNotifications": {
            "mdmAgent": true,
            "setupAssistant": true
        },
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "segmentId": 0,
        "devicePolicyStatus": {
            "pushed": true,
            "audit": [
                {
                    "profileId": "string",
                    "uuid": "string",
                    "hasConfig": true,
                    "config": {
                        "version": 0
                    },
                    "device": {
                        "version": 0
                    }
                }
            ]
        }
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5086
message string optional
Attached adm profiles can not be added
{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}
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"
    }
}