Favicon

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

Update admDevice

Required Permission: mdm.apple.device.update

Update admDevice

PUT
/v1/organizations/:organizationId/mdm/apple/enterprise/devices/:admDeviceId
Copy to clipboard

Update admDevice

Required Permission: mdm.apple.device.update

Update admDevice

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,}))$
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
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatePolicy object optional
books array [object] optional
type string optional
asset store
id string optional
≤ 128 characters
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
mdmUserId string optional
Match pattern: ^[a-fA-F0-9]{24}$
skipPersonalInfo boolean optional
segmentId integer optional
≥ 0
{
    "displayName": "string",
    "tags": [
        "string"
    ],
    "policyId": "string",
    "admPolicyAssignments": [
        {
            "admPolicyId": "string",
            "priority": 0
        }
    ],
    "admVppLocationId": "string",
    "profiles": [
        "string"
    ],
    "applications": [
        {
            "admApplication": "string",
            "managed": true,
            "vpp": true,
            "iOSApp": true,
            "configuration": {},
            "action": "forceInstall",
            "actionStatus": "forceInstall",
            "scripts": {
                "preInstall": "string",
                "postInstall": "string",
                "audit": "string",
                "enforce": "string",
                "runner": "string"
            },
            "updatePolicy": {}
        }
    ],
    "books": [
        {
            "type": "asset",
            "id": "string"
        }
    ],
    "scripts": [
        {
            "type": "once",
            "id": "string",
            "loopTime": 0,
            "resetDate": "2024-01-01T00: 00:00Z",
            "arguments": "string",
            "argumentsProcessed": "string",
            "name": "string",
            "description": "string",
            "runner": "string"
        }
    ],
    "mdmUserId": "string",
    "skipPersonalInfo": true,
    "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
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.
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
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
format object optional
location string optional
≤ 256 characters
password string optional
≤ 256 characters
allowAllAppsAccess boolean optional
keyIsExtractable boolean 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
policies array [object] optional
devices array [object] optional
useCustomFileVaultCertificates boolean optional
parentAdmProfileId string optional
Match pattern: ^[a-fA-F0-9]{24}$
applications array [object] optional
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
admApplication string required
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatePolicy object optional
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.
type string optional
asset store
id string optional
≤ 128 characters
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.
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
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.
title string optional
≤ 256 characters
description string optional
≤ 500 characters
url string optional
≤ 500 characters
iconBase64 string optional
iconUrl string optional
≤ 500 characters
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
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.
allowLocation boolean optional
Flag enabling location tracking for iOS and iPadOS devices through MDM agent for geofencing and asset management.
allowLocationMacos boolean optional
Flag enabling location tracking for macOS devices through MDM agent requiring user privacy consent and system permissions.
allowPackageTime boolean optional
Flag enabling application usage time tracking for monitoring employee productivity and application license optimization purposes.
allowPackageTransfer boolean optional
Flag enabling network data transfer monitoring per application for bandwidth analysis and security threat detection.
allowDeviceInfoBatteryUsage boolean optional
Flag enabling battery usage statistics collection per application for power consumption analysis and device health monitoring.
allowDeviceInfoBluetooth boolean optional
Flag enabling Bluetooth device discovery and connection monitoring for peripheral inventory and security compliance tracking.
allowDeviceInfoSystemInfo boolean optional
Flag enabling comprehensive system information collection including hardware specifications OS versions and installed software inventory.
appBlacklist array [object] optional
List of unauthorized applications to block or remove from managed devices for security compliance and acceptable use enforcement.
bundleId string optional
Application bundle identifier matching installed app for blacklist enforcement on iOS iPadOS and macOS platforms.
≤ 256 characters
action string optional
Enforcement action defining whether to block app launch or automatically remove application from managed device.
block remove
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
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.
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
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
format object optional
location string optional
≤ 256 characters
password string optional
≤ 256 characters
allowAllAppsAccess boolean optional
keyIsExtractable boolean 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
policies array [object] optional
devices array [object] optional
useCustomFileVaultCertificates boolean optional
parentAdmProfileId string optional
Match pattern: ^[a-fA-F0-9]{24}$
applications array [object] optional
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
admApplication string required
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatePolicy object optional
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.
type string optional
asset store
id string optional
≤ 128 characters
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.
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
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.
title string optional
≤ 256 characters
description string optional
≤ 500 characters
url string optional
≤ 500 characters
iconBase64 string optional
iconUrl string optional
≤ 500 characters
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
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.
allowLocation boolean optional
Flag enabling location tracking for iOS and iPadOS devices through MDM agent for geofencing and asset management.
allowLocationMacos boolean optional
Flag enabling location tracking for macOS devices through MDM agent requiring user privacy consent and system permissions.
allowPackageTime boolean optional
Flag enabling application usage time tracking for monitoring employee productivity and application license optimization purposes.
allowPackageTransfer boolean optional
Flag enabling network data transfer monitoring per application for bandwidth analysis and security threat detection.
allowDeviceInfoBatteryUsage boolean optional
Flag enabling battery usage statistics collection per application for power consumption analysis and device health monitoring.
allowDeviceInfoBluetooth boolean optional
Flag enabling Bluetooth device discovery and connection monitoring for peripheral inventory and security compliance tracking.
allowDeviceInfoSystemInfo boolean optional
Flag enabling comprehensive system information collection including hardware specifications OS versions and installed software inventory.
appBlacklist array [object] optional
List of unauthorized applications to block or remove from managed devices for security compliance and acceptable use enforcement.
bundleId string optional
Application bundle identifier matching installed app for blacklist enforcement on iOS iPadOS and macOS platforms.
≤ 256 characters
action string optional
Enforcement action defining whether to block app launch or automatically remove application from managed device.
block remove
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
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.
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.
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
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
admApplication string required
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
updatePolicy object optional
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.
type string optional
asset store
id string optional
≤ 128 characters
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.
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
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.
title string optional
≤ 256 characters
description string optional
≤ 500 characters
url string optional
≤ 500 characters
iconBase64 string optional
iconUrl string optional
≤ 500 characters
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
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.
allowLocation boolean optional
Flag enabling location tracking for iOS and iPadOS devices through MDM agent for geofencing and asset management.
allowLocationMacos boolean optional
Flag enabling location tracking for macOS devices through MDM agent requiring user privacy consent and system permissions.
allowPackageTime boolean optional
Flag enabling application usage time tracking for monitoring employee productivity and application license optimization purposes.
allowPackageTransfer boolean optional
Flag enabling network data transfer monitoring per application for bandwidth analysis and security threat detection.
allowDeviceInfoBatteryUsage boolean optional
Flag enabling battery usage statistics collection per application for power consumption analysis and device health monitoring.
allowDeviceInfoBluetooth boolean optional
Flag enabling Bluetooth device discovery and connection monitoring for peripheral inventory and security compliance tracking.
allowDeviceInfoSystemInfo boolean optional
Flag enabling comprehensive system information collection including hardware specifications OS versions and installed software inventory.
appBlacklist array [object] optional
List of unauthorized applications to block or remove from managed devices for security compliance and acceptable use enforcement.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
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.
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.
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
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
admApplication string required
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
updatePolicy object optional
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.
type string optional
asset store
id string optional
≤ 128 characters
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.
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
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.
title string optional
≤ 256 characters
description string optional
≤ 500 characters
url string optional
≤ 500 characters
iconBase64 string optional
iconUrl string optional
≤ 500 characters
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
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.
allowLocation boolean optional
Flag enabling location tracking for iOS and iPadOS devices through MDM agent for geofencing and asset management.
allowLocationMacos boolean optional
Flag enabling location tracking for macOS devices through MDM agent requiring user privacy consent and system permissions.
allowPackageTime boolean optional
Flag enabling application usage time tracking for monitoring employee productivity and application license optimization purposes.
allowPackageTransfer boolean optional
Flag enabling network data transfer monitoring per application for bandwidth analysis and security threat detection.
allowDeviceInfoBatteryUsage boolean optional
Flag enabling battery usage statistics collection per application for power consumption analysis and device health monitoring.
allowDeviceInfoBluetooth boolean optional
Flag enabling Bluetooth device discovery and connection monitoring for peripheral inventory and security compliance tracking.
allowDeviceInfoSystemInfo boolean optional
Flag enabling comprehensive system information collection including hardware specifications OS versions and installed software inventory.
appBlacklist array [object] optional
List of unauthorized applications to block or remove from managed devices for security compliance and acceptable use enforcement.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
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.
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
deviceAudiences array [object] optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
reasons array [string] optional
admVppLocation object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
countryISO2ACode string optional
≤ 256 characters
defaultPlatform string optional
≤ 256 characters
locationName string optional
≤ 256 characters
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
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
format object optional
uuid string optional
uuid
base64 string optional
base64
location string optional
≤ 256 characters
password string optional
≤ 256 characters
allowAllAppsAccess boolean optional
keyIsExtractable boolean 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
policies array [object] optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
devices array [object] optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
displayName string optional
≤ 256 characters
useCustomFileVaultCertificates boolean optional
parentAdmProfileId string optional
Match pattern: ^[a-fA-F0-9]{24}$
applications array [object] optional
admApplication string required
Match pattern: ^[a-fA-F0-9]{24}$
managed boolean optional
vpp boolean optional
iOSApp boolean optional
configuration object optional
action string optional
forceInstall available requiredForSetup
actionStatus string optional
forceInstall available requiredForSetup available-install
scripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatePolicy object optional
books array [object] optional
type string optional
asset store
id string optional
≤ 128 characters
booksInfo array [object] optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
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
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
origin string optional
agent ip
date string optional
Format: date-time
latitude number optional
Format: float · ≥ -90 · ≤ 90
longitude number optional
Format: float · ≥ -180 · ≤ 180
ip string optional
≤ 128 characters
lastReportDate string optional
Format: date-time
address object optional
address string optional
≤ 500 characters
number string optional
≤ 500 characters
postalCode string optional
≤ 500 characters
city string optional
≤ 500 characters
country string optional
≤ 500 characters
ip object optional
origin string optional
agent ip
date string optional
Format: date-time
latitude number optional
Format: float · ≥ -90 · ≤ 90
longitude number optional
Format: float · ≥ -180 · ≤ 180
ip string optional
≤ 128 characters
lastReportDate string optional
Format: date-time
address object optional
address string optional
≤ 500 characters
number string optional
≤ 500 characters
postalCode string optional
≤ 500 characters
city string optional
≤ 500 characters
country string optional
≤ 500 characters
counts object optional
users integer optional
≥ 0
lastReports object optional
sync string optional
Format: date-time
agent object optional
location string optional
Format: date-time
packageTime string optional
Format: date-time
packageTransfer string optional
Format: date-time
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
profileId string optional
≤ 256 characters
uuid string optional
≤ 256 characters
hasConfig boolean optional
config object optional
version integer optional
≥ 0
device object optional
version integer optional
≥ 0
{
    "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"
        },
        "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,
                    "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,
                "allowPackageTransfer": true,
                "allowDeviceInfoBatteryUsage": true,
                "allowDeviceInfoBluetooth": true,
                "allowDeviceInfoSystemInfo": true,
                "appBlacklist": [
                    {
                        "bundleId": "com.example.unauthorized",
                        "action": "block"
                    }
                ]
            },
            "segmentId": "1"
        },
        "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,
                    "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,
                "allowPackageTransfer": true,
                "allowDeviceInfoBatteryUsage": true,
                "allowDeviceInfoBluetooth": true,
                "allowDeviceInfoSystemInfo": true,
                "appBlacklist": [
                    {
                        "bundleId": "com.example.unauthorized",
                        "action": "block"
                    }
                ]
            },
            "segmentId": "1"
        },
        "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": "string",
                "managed": true,
                "vpp": true,
                "iOSApp": true,
                "configuration": {},
                "action": "forceInstall",
                "actionStatus": "forceInstall",
                "scripts": {
                    "preInstall": "string",
                    "postInstall": "string",
                    "audit": "string",
                    "enforce": "string",
                    "runner": "string"
                },
                "updatePolicy": {}
            }
        ],
        "books": [
            {
                "type": "asset",
                "id": "string"
            }
        ],
        "booksInfo": [
            {}
        ],
        "scripts": [
            {
                "type": "once",
                "id": "string",
                "loopTime": 0,
                "resetDate": "2024-01-01T00: 00:00Z",
                "arguments": "string",
                "argumentsProcessed": "string",
                "name": "string",
                "description": "string",
                "runner": "string"
            }
        ],
        "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"
    }
}