Favicon

You are here: Home > API Reference > Android > Policies > Update device policy

Update device policy

Required Permission: mdm.android.policy.update

Updates the configuration, restrictions, and security settings for an existing policy.

PUT
/v1/organizations/:organizationId/mdm/android/enterprise/policies/:emmPolicyId
Copy to clipboard

Update device policy

Required Permission: mdm.android.policy.update

Updates the configuration, restrictions, and security settings for an existing policy.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
emmPolicyId string
required
Android Enterprise policy unique identifier used in URL path for retrieving or modifying specific policy configuration.
Match pattern: ^[a-fA-F0-9]{24}$
Body Params application/json
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 128 characters
description string optional
Detailed policy description explaining configuration purpose business requirements and device restrictions for documentation purposes.
≤ 256 characters
config object optional
Google Android Enterprise policy configuration object containing device restrictions security settings and compliance rules.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed Android devices.
mdmAssetId string required
Match pattern: ^[a-fA-F0-9]{24}$
location string required
≤ 256 characters
assetName string optional
≤ 256 characters
scope string required
user system all-users
agentConfiguration object optional
MDM agent behavior settings controlling location tracking application monitoring and network status reporting on Android devices.
allowLocation boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
allowNetworkStatus boolean optional
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
displayDeviceName boolean optional
settingAction any optional
whitelistedApps array [string] optional
escapeHatchPassword string optional
≤ 256 characters
backgroundUrl string optional
≤ 500 characters
iconSize string optional
small medium large
screenAlwaysOn boolean optional
unlockPassword string optional
≤ 256 characters
inactivityLockTime integer optional
≥ 0 · ≤ 9007199254740991
startingUpApps array [object] optional
packageName string required
≤ 256 characters
config object required
appsLayout array optional
type string required
folder
package string required
≤ 256 characters
action any required
children array required
type string required
action
package string required
≤ 256 characters
action any required
header object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
footer object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
certificateProviderIds array [string] optional
List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
applications array [object] optional
List of application assignments defining managed apps with installation actions configuration and update policies for deployment.
emmApplicationId string required
Match pattern: ^[a-fA-F0-9]{24}$
configuration string optional
action string optional
forceInstall available
updatePolicy object optional
customAppConfig object optional
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0 · ≤ 9007199254740991
{
    "name": "string",
    "description": "string",
    "config": {},
    "assets": [
        {
            "mdmAssetId": "string",
            "location": "string",
            "assetName": "string",
            "scope": "user"
        }
    ],
    "agentConfiguration": {
        "allowLocation": true,
        "allowPackageTime": true,
        "allowPackageTransfer": true,
        "allowNetworkStatus": true
    },
    "kioskLauncherConfiguration": {
        "displayDeviceName": true,
        "settingAction": "",
        "whitelistedApps": [
            "string"
        ],
        "escapeHatchPassword": "string",
        "backgroundUrl": "string",
        "iconSize": "small",
        "screenAlwaysOn": true,
        "unlockPassword": "string",
        "inactivityLockTime": 0,
        "startingUpApps": [
            {
                "packageName": "string",
                "config": {}
            }
        ],
        "appsLayout": [
            {
                "type": "app",
                "package": "string"
            }
        ],
        "header": {
            "text": "string",
            "fontSize": "small"
        },
        "footer": {
            "text": "string",
            "fontSize": "small"
        }
    },
    "certificateProviderIds": [
        "string"
    ],
    "applications": [
        {
            "emmApplicationId": "string",
            "configuration": "string",
            "action": "forceInstall",
            "updatePolicy": {},
            "customAppConfig": {}
        }
    ],
    "segmentId": 0
}

Responses

200 Response application/json
status boolean required
data object required
id string optional
Unique Android Enterprise policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 128 characters
description string optional
Detailed policy description explaining configuration purpose business requirements and device restrictions for documentation purposes.
≤ 256 characters
version string optional
Policy version identifier synchronized with Google Android Enterprise policy version for change tracking purposes.
≤ 128 characters
config object optional
Google Android Enterprise policy configuration object containing device restrictions security settings and compliance rules.
_config object optional
Internal configuration data restricted to administrator access level containing sensitive policy credentials and system metadata.
packages object optional
Application package information mapping containing installed app details versions and configuration for reporting purposes.
emmEnterprise string optional
Android Enterprise (EMM) account identifier linked to Google Managed Play for device and application management.
Match pattern: ^[a-fA-F0-9]{24}$
private boolean optional
Flag indicating whether policy is private to organization or shared across enterprise for template purposes.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed Android devices.
mdmAssetId string required
Match pattern: ^[a-fA-F0-9]{24}$
location string required
≤ 256 characters
assetName string optional
≤ 256 characters
scope string required
user system all-users
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
agentConfiguration object optional
MDM agent behavior settings controlling location tracking application monitoring and network status reporting on Android devices.
allowLocation boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
allowNetworkStatus boolean optional
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
displayDeviceName boolean optional
settingAction any optional
whitelistedApps array [string] optional
escapeHatchPassword string optional
≤ 256 characters
backgroundUrl string optional
≤ 500 characters
iconSize string optional
small medium large
screenAlwaysOn boolean optional
unlockPassword string optional
≤ 256 characters
inactivityLockTime integer optional
≥ 0 · ≤ 9007199254740991
startingUpApps array [object] optional
packageName string required
≤ 256 characters
config object required
appsLayout array optional
type string required
folder
package string required
≤ 256 characters
action any required
children array required
type string required
action
package string required
≤ 256 characters
action any required
header object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
footer object optional
text string optional
≤ 1000 characters
fontSize string optional
small medium large
certificateProviderIds array optional
List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
applications array [object] required
List of application assignments defining managed apps with installation actions configuration and update policies for deployment.
emmApplicationId string required
Match pattern: ^[a-fA-F0-9]{24}$
configuration string optional
action string optional
forceInstall available
updatePolicy object optional
customAppConfig object optional
applicationsInfo array [object] required
Enriched application metadata including app details names icons versions for dashboard display and reporting purposes.
emmApplicationId string required
Match pattern: ^[a-fA-F0-9]{24}$
emmApplication object optional
id string required
Unique identifier for the Android enterprise application configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string required
Unique identifier for organization managing Android enterprise application deployments and configurations.
Match pattern: ^[a-fA-F0-9]{24}$
emmEnterpriseId string required
Unique identifier for Android Enterprise enrollment binding application to Google Play managed configuration.
Match pattern: ^[a-fA-F0-9]{24}$
type string required
Application source type specifying build selection strategy for enterprise deployment and version management.
build lastBuild lastGitBranchBuild lastGitTagBuild lastTagBuild
config object required
Configuration object defining application source and version selection strategy for enterprise deployment.
buildId string optional
Specific build identifier for application deployment when using direct build reference configuration.
Match pattern: ^[a-fA-F0-9]{24}$
applicationId string optional
Application identifier for deploying specific app version when using application reference configuration.
Match pattern: ^[a-fA-F0-9]{24}$
mdmAssetId string optional
MDM asset identifier for deploying enterprise private application when using asset reference configuration.
Match pattern: ^[a-fA-F0-9]{24}$
filter string optional
Build selection filter criteria for automatic version selection when using dynamic build strategies.
≤ 256 characters
version integer optional
Sequential version number tracking Android enterprise application configuration changes and synchronization state.
≥ 0 · ≤ 9007199254740991
updatedAt string required
Timestamp indicating when Android enterprise application configuration was last modified or synchronized.
createdAt string required
Timestamp indicating when Android enterprise application configuration was initially created in system.
origin any optional
Application source origin indicating whether application comes from organization library or public catalog.
info object optional
Detailed application metadata including version information, assets, and signing details for deployment.
id string required
Match pattern: ^[a-fA-F0-9]{24}$
bundleId string required
≤ 256 characters
name string required
≤ 256 characters
icon string required
≤ 256 characters
processedVersionName string required
≤ 128 characters
versionCode string required
≤ 128 characters
size string optional
≤ 128 characters
originalExtension string optional
≤ 128 characters
applicationInfo object optional
disabled boolean optional
signatures object optional
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "version": "string",
        "config": {},
        "_config": {},
        "packages": {},
        "emmEnterprise": "string",
        "private": true,
        "assets": [
            {
                "mdmAssetId": "string",
                "location": "string",
                "assetName": "string",
                "scope": "user"
            }
        ],
        "assetsInfo": [
            {}
        ],
        "updatedAt": "string",
        "createdAt": "string",
        "agentConfiguration": {
            "allowLocation": true,
            "allowPackageTime": true,
            "allowPackageTransfer": true,
            "allowNetworkStatus": true
        },
        "kioskLauncherConfiguration": {
            "displayDeviceName": true,
            "settingAction": "",
            "whitelistedApps": [
                "string"
            ],
            "escapeHatchPassword": "string",
            "backgroundUrl": "string",
            "iconSize": "small",
            "screenAlwaysOn": true,
            "unlockPassword": "string",
            "inactivityLockTime": 0,
            "startingUpApps": [
                {
                    "packageName": "string",
                    "config": {}
                }
            ],
            "appsLayout": [
                {
                    "type": "app",
                    "package": "string"
                }
            ],
            "header": {
                "text": "string",
                "fontSize": "small"
            },
            "footer": {
                "text": "string",
                "fontSize": "small"
            }
        },
        "certificateProviderIds": [
            "string"
        ],
        "applications": [
            {
                "emmApplicationId": "string",
                "configuration": "string",
                "action": "forceInstall",
                "updatePolicy": {},
                "customAppConfig": {}
            }
        ],
        "applicationsInfo": [
            {
                "emmApplicationId": "string",
                "emmApplication": {
                    "id": "string",
                    "organizationId": "string",
                    "emmEnterpriseId": "string",
                    "type": "build",
                    "config": {
                        "buildId": "string",
                        "applicationId": "string",
                        "mdmAssetId": "string",
                        "filter": "string"
                    },
                    "version": 0,
                    "updatedAt": "string",
                    "createdAt": "string",
                    "origin": "library",
                    "info": {
                        "id": "string",
                        "bundleId": "string",
                        "name": "string",
                        "icon": "string",
                        "processedVersionName": "string",
                        "versionCode": "string",
                        "size": "string",
                        "originalExtension": "string",
                        "applicationInfo": {
                            "id": "string",
                            "slug": "string",
                            "name": "string",
                            "picture": "string"
                        },
                        "disabled": true,
                        "signatures": {
                            "sha1": "string",
                            "sha256": "string"
                        }
                    }
                }
            }
        ],
        "segmentId": 0
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5050
message string optional
Feature not allowed for you billing plan
{
    "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"
    }
}