Favicon

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

Create device policy

Required Permission: mdm.android.policy.create

Creates a new policy with specified configurations, restrictions, and security settings.

POST
https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "config": {},
  "assets": [
    {}
  ],
  "agentConfiguration": {
    "allowLocation": true,
    "allowPackageTime": true,
    "allowPackageTransfer": true,
    "allowNetworkStatus": true,
    "policyFeatures": {}
  },
  "kioskLauncherConfiguration": {
    "displayDeviceName": true,
    "settingAction": "",
    "whitelistedApps": [],
    "escapeHatchPassword": "string",
    "backgroundUrl": "string",
    "iconSize": "small",
    "screenAlwaysOn": true,
    "unlockPassword": "string",
    "inactivityLockTime": 0,
    "startingUpApps": [],
    "appsLayout": [],
    "header": {},
    "footer": {}
  },
  "certificateProviderIds": [
    "string"
  ],
  "certificateProviderAssignments": [
    {}
  ],
  "applications": [
    {}
  ],
  "segmentId": 0,
  "exposeToChildren": true,
  "bookmarks": [
    {}
  ]
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "config": {},
    "assets": [
      {}
    ],
    "agentConfiguration": {
      "allowLocation": true,
      "allowPackageTime": true,
      "allowPackageTransfer": true,
      "allowNetworkStatus": true,
      "policyFeatures": {}
    },
    "kioskLauncherConfiguration": {
      "displayDeviceName": true,
      "settingAction": "",
      "whitelistedApps": [],
      "escapeHatchPassword": "string",
      "backgroundUrl": "string",
      "iconSize": "small",
      "screenAlwaysOn": true,
      "unlockPassword": "string",
      "inactivityLockTime": 0,
      "startingUpApps": [],
      "appsLayout": [],
      "header": {},
      "footer": {}
    },
    "certificateProviderIds": [
      "string"
    ],
    "certificateProviderAssignments": [
      {}
    ],
    "applications": [
      {}
    ],
    "segmentId": 0,
    "exposeToChildren": true,
    "bookmarks": [
      {}
    ]
  }),
});

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

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "name": "string",
      "description": "string",
      "config": {},
      "assets": [
        {}
      ],
      "agentConfiguration": {
        "allowLocation": true,
        "allowPackageTime": true,
        "allowPackageTransfer": true,
        "allowNetworkStatus": true,
        "policyFeatures": {}
      },
      "kioskLauncherConfiguration": {
        "displayDeviceName": true,
        "settingAction": "",
        "whitelistedApps": [],
        "escapeHatchPassword": "string",
        "backgroundUrl": "string",
        "iconSize": "small",
        "screenAlwaysOn": true,
        "unlockPassword": "string",
        "inactivityLockTime": 0,
        "startingUpApps": [],
        "appsLayout": [],
        "header": {},
        "footer": {}
      },
      "certificateProviderIds": [
        "string"
      ],
      "certificateProviderAssignments": [
        {}
      ],
      "applications": [
        {}
      ],
      "segmentId": 0,
      "exposeToChildren": true,
      "bookmarks": [
        {}
      ]
    },
)

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,}))$

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 any optional
allowPackageTime any optional
allowPackageTransfer any optional
allowNetworkStatus any optional
policyFeatures object optional
defaultViewFeature string optional
bookmarks applications files notifications status
toggledFeatures array [object] optional
enableDefaultView any optional
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
displayDeviceName any 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 any 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
name string optional
≤ 256 characters
children array 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 deprecated
Deprecated: Use certificateProviderAssignments instead. List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
certificateProviderAssignments array [object] optional
List of certificate provider assignments including credential storage preferences for deploying PKI credentials to Android devices.
certificateProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
storeCredentials any required
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
exposeToChildren any optional
bookmarks array [object] optional
title string required
≤ 256 characters
description string optional
≤ 500 characters
url string required
≤ 500 characters · Format: uri
iconBase64 string optional
iconUrl string optional
≤ 500 characters
{
    "name": "string",
    "description": "string",
    "config": {},
    "assets": [
        {
            "mdmAssetId": "string",
            "location": "string",
            "assetName": "string",
            "scope": "user"
        }
    ],
    "agentConfiguration": {
        "allowLocation": true,
        "allowPackageTime": true,
        "allowPackageTransfer": true,
        "allowNetworkStatus": true,
        "policyFeatures": {
            "defaultViewFeature": "bookmarks",
            "toggledFeatures": [
                {
                    "name": "bookmarks",
                    "active": true
                }
            ],
            "enableDefaultView": 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"
    ],
    "certificateProviderAssignments": [
        {
            "certificateProviderId": "string",
            "storeCredentials": true
        }
    ],
    "applications": [
        {
            "emmApplicationId": "string",
            "configuration": "string",
            "action": "forceInstall",
            "updatePolicy": {},
            "customAppConfig": {}
        }
    ],
    "segmentId": 0,
    "exposeToChildren": true,
    "bookmarks": [
        {
            "title": "string",
            "description": "string",
            "url": "https://example.com",
            "iconBase64": "string",
            "iconUrl": "string"
        }
    ]
}

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 any 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.
bookmarks array [object] optional
title string required
≤ 256 characters
description string optional
≤ 500 characters
url string required
≤ 500 characters · Format: uri
iconBase64 string optional
iconUrl string optional
≤ 500 characters
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 any optional
allowPackageTime any optional
allowPackageTransfer any optional
allowNetworkStatus any optional
policyFeatures object optional
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
displayDeviceName any 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 any optional
unlockPassword string optional
≤ 256 characters
inactivityLockTime integer optional
≥ 0 · ≤ 9007199254740991
startingUpApps array [object] optional
appsLayout array optional
header object optional
footer object optional
certificateProviderIds array optional deprecated
Deprecated: Use certificateProviderAssignments instead. List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
certificateProviderAssignments array [object] optional
List of certificate provider assignments including credential storage preferences for deploying PKI credentials to Android devices.
certificateProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
storeCredentials any required
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
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0 · ≤ 9007199254740991
exposeToChildren any optional 
{
    "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": [
            {}
        ],
        "bookmarks": [
            {
                "title": "string",
                "description": "string",
                "url": "https://example.com",
                "iconBase64": "string",
                "iconUrl": "string"
            }
        ],
        "updatedAt": "string",
        "createdAt": "string",
        "agentConfiguration": {
            "allowLocation": true,
            "allowPackageTime": true,
            "allowPackageTransfer": true,
            "allowNetworkStatus": true,
            "policyFeatures": {
                "defaultViewFeature": "bookmarks",
                "toggledFeatures": [
                    {
                        "name": "bookmarks",
                        "active": true
                    }
                ],
                "enableDefaultView": 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"
        ],
        "certificateProviderAssignments": [
            {
                "certificateProviderId": "string",
                "storeCredentials": true
            }
        ],
        "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",
                                "signatureScheme": "V1"
                            }
                        ]
                    }
                }
            }
        ],
        "segmentId": 0,
        "exposeToChildren": true
    }
}
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"
    }
}