Add a new Restrictions payload configuration to an existing profile

Create Android Restrictions Policy payload

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

allow_non_market_app_instalintegerOptional

Whether installing apps from non-market sources is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_disabling_cellular_dataintegerOptional

Whether disabling cellular data is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_app_auto_syncintegerOptional

Whether app auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_data_while_roamingintegerOptional

Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_background_dataintegerOptional

Whether background data usage is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bluetoothintegerOptional

Whether Bluetooth is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_usbintegerOptional

Whether USB connectivity is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_cameraintegerOptional

Whether the camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_storage_encryptionintegerOptional

Whether storage encryption enforcement is configured. 0 = Allow encryption, 1 = Disable encryption, 2 = Not Configured. Default: 2

external_storage_encryptionintegerOptional

Whether external storage encryption is required. 0 = Not Required, 1 = Required, 2 = Not Configured. Default: 2

allow_nfcintegerOptional

Whether NFC is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_disabling_gpsintegerOptional

Whether disabling GPS is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_microphoneintegerOptional

Whether the microphone is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bluetooth_tetheringintegerOptional

Whether Bluetooth tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wifiintegerOptional

Whether Wi-Fi is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_whitelist_wifi_onlyintegerOptional

Whether only allowlisted Wi-Fi networks are permitted. 0 = All networks allowed, 1 = Allowlisted only. Default: 0

allow_wifi_tetheringintegerOptional

Whether Wi-Fi tethering (hotspot) is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_tetheringintegerOptional

Whether USB tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_tetheringintegerOptional

Whether tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_debugintegerOptional

Whether USB debugging is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sd_cardintegerOptional

Whether SD card access is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sd_card_writeintegerOptional

Whether writing to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_clipboardintegerOptional

Whether clipboard access is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_crash_reportintegerOptional

Whether Google crash reports are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_mock_locationintegerOptional

Whether mock locations are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_settingsintegerOptional

Whether access to device settings is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_factory_resetintegerOptional

Whether factory reset is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wallpaper_changeintegerOptional

Whether wallpaper changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_statusbar_expansionintegerOptional

Whether status bar expansion is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_ota_upgradeintegerOptional

Whether OTA upgrades are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_vpnintegerOptional

Whether VPN is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_screen_captureintegerOptional

Whether screen capture is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_power_offintegerOptional

Whether powering off the device is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_media_playerintegerOptional

Whether USB media player is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_marketintegerOptional

Whether the Android Market (Play Store) is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_non_market_appsintegerOptional

Whether non-market apps are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_personal_space_non_market_appsintegerOptional

Whether non-market apps in personal space are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_you_tubeintegerOptional

Whether YouTube is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_voice_dialerintegerOptional

Whether the voice dialer is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_install_appintegerOptional

Whether app installation is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_uninstall_appintegerOptional

Whether app uninstallation is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_browserintegerOptional

Whether the Android browser is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_fraud_warningintegerOptional

Whether browser fraud warnings are allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_popupsintegerOptional

Whether browser popups are allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_javascriptintegerOptional

Whether browser JavaScript is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_autofillintegerOptional

Whether browser autofill is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_cookiesintegerOptional

Whether browser cookies are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_syncintegerOptional

Whether sync while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_voice_callsintegerOptional

Whether voice calls while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_pushintegerOptional

Whether push notifications while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_dataintegerOptional

Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_s_voiceintegerOptional

Whether S Voice is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_stop_system_appintegerOptional

Whether stopping system apps is allowed. 0 = Restricted, 1 = Allowed. Default: 1

disable_clear_storage_and_force_stop_appsJSON ArrayOptional

List of apps excluded from clear storage and force stop restrictions

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

allow_app_controlintegerOptional

Whether app control restrictions are enabled. 0 = Disabled, 1 = Enabled. Default: 1

allow_clear_app_data_and_force_stopintegerOptional

Whether clearing app data and force stopping apps is allowed. 0 = Restricted, 1 = Allowed, 2 = Restrict Specific Apps. Default: 1

allow_airplane_modeintegerOptional

Whether airplane mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_beamintegerOptional

Whether Android Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_background_process_limitintegerOptional

Whether background process limit is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_s_beamintegerOptional

Whether S Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wifi_directintegerOptional

Whether Wi-Fi Direct is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_headphoneintegerOptional

Whether headphone use is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_smart_clip_modeintegerOptional

Whether Smart Clip mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_clipboard_shareintegerOptional

Whether clipboard sharing is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_firmware_recoveryintegerOptional

Whether firmware recovery is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sdcard_moveintegerOptional

Whether moving apps to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_safe_modeintegerOptional

Whether safe mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_home_keyintegerOptional

Whether the home key is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_lock_screen_menuintegerOptional

Whether the lock screen menu is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_developer_modeintegerOptional

Whether developer mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_kill_activity_on_leaveintegerOptional

Whether killing activities on leave is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_lock_screen_viewintegerOptional

Whether the lock screen view is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_share_listintegerOptional

Whether the share list is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_play_protect_monitoringintegerOptional

Whether Google Play Protect monitoring is allowed. 0 = Restricted, 1 = Allowed. Default: 0

allow_user_mobile_data_limitintegerOptional

Whether the user can set mobile data limits. 0 = Restricted, 1 = Allowed. Default: 1

allow_date_time_changeintegerOptional

Whether changing date and time is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_account_auto_syncintegerOptional

Whether Google account auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_user_profileintegerOptional

Whether user profiles are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_app_notification_modeintegerOptional

Whether app notification mode changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_audio_recordintegerOptional

Whether audio recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_video_recordintegerOptional

Whether video recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_host_storageintegerOptional

Whether USB host storage is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_use_network_timeintegerOptional

Whether using network time is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_gmailintegerOptional

Whether Gmail is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_mapsintegerOptional

Whether Google Maps is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_discoverableintegerOptional

Whether Bluetooth discoverable mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_pairingintegerOptional

Whether Bluetooth pairing is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_outgoing_callsintegerOptional

Whether Bluetooth outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_pc_connectionintegerOptional

Whether Bluetooth PC connections are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_data_transferintegerOptional

Whether Bluetooth data transfer is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_emergency_calls_onlyintegerOptional

Whether emergency calls only mode is enforced. 0 = Restricted, 1 = Allowed. Default: 1

allow_mmsintegerOptional

Whether MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_mmsintegerOptional

Whether incoming MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_mmsintegerOptional

Whether outgoing MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_smsintegerOptional

Whether SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_smsintegerOptional

Whether incoming SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_smsintegerOptional

Whether outgoing SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_callintegerOptional

Whether phone calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_callintegerOptional

Whether outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_callintegerOptional

Whether incoming calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_user_add_accountsintegerOptional

Whether the user can add accounts. 0 = Restricted, 1 = Allowed. Default: 1

restricted_account_typesJSON ArrayOptional

List of restricted account type identifiers

Show Sub-Attributes

string

allow_personal_accounts_in_playstorebooleanOptional

Whether personal accounts are allowed in the Play Store. Default: true

allow_s_finderintegerOptional

Whether S Finder is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_air_commandintegerOptional

Whether Air Command is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_air_viewintegerOptional

Whether Air View is allowed. 0 = Restricted, 1 = Allowed. Default: 1

app_permission_policyintegerOptional

Global runtime permission policy. 0 = Prompt, 1 = Auto Grant, 2 = Auto Deny, 4 = Not Configured. Default: 4

allow_timezonestringOptional

Timezone identifier to enforce (e.g., America/New_York). Empty = User Controlled

allow_ambient_displaybooleanOptional

Whether ambient display (always-on display) is enabled. Default: true

allow_brightness_configbooleanOptional

Whether the user can configure screen brightness. Default: true

adaptive_brightnessbooleanOptional

Whether adaptive brightness is enabled. Default: true

brightness_valueintegerOptional

Screen brightness level (0-255). Default: 126

allow_date_time_settingsbooleanOptional

Whether the user can change date and time settings. Default: true

allow_config_screen_timeoutbooleanOptional

Whether the user can configure screen timeout. Default: true

screen_timeoutintegerOptional

Screen timeout duration in seconds. Default: 5

allow_printingbooleanOptional

Whether printing is allowed. Default: true

allow_non_secure_keypadintegerOptional

Whether the non-secure keypad is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_contact_to_deviceintegerOptional

Whether contact sync to device is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_knox_app_storeintegerOptional

Whether the Knox App Store is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_keyguard_cameraintegerOptional

Whether the keyguard camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_keyguard_notificationsintegerOptional

Keyguard notification visibility level. 0 = Show All, 1 = Hide Sensitive, 2 = Hide All. Default: 0

set_roaming_always_onbooleanOptional

Whether data roaming is forced to always on. Default: false

allow_data_saverbooleanOptional

Whether Data Saver mode is allowed. Default: false

allow_data_saver_restrictionbooleanOptional

Whether Data Saver restriction is enabled. Default: false

allow_cert_based_authentication_for_managed_appsbooleanOptional

Whether certificate-based authentication is allowed for managed apps. Default: true

allow_install_or_modify_certificatesbooleanOptional

Whether the user can install or modify certificates. Default: true

allow_secured_wifiintegerOptional

Whether secured Wi-Fi is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_auto_fill_servicebooleanOptional

Whether the autofill service is allowed. Default: false

allow_all_apps_accessintegerOptional

Whether all apps are accessible in Managed Google Play. 0 = Restricted, 1 = Allowed. Default: 0

allow_usb_file_transferbooleanOptional

Whether USB file transfer is allowed. Default: true

allow_personal_space_screen_capturebooleanOptional

Whether screen capture is allowed in the personal space. Default: true

allow_personal_space_camerabooleanOptional

Whether the camera is allowed in the personal space. Default: true

app_filter_typeintegerOptional

App filtering mode. -1 = Not Configured. Default: -1

apps_listJSON ArrayOptional

List of apps for the app filter

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"allow_disabling_cellular_data":1,"allow_non_market_app_instal":1,"allow_data_while_roaming":1,"allow_camera":1,"allow_bluetooth":4,"external_storage_encryption":2,"allow_storage_encryption":2,"allow_app_auto_sync":1,"allow_background_data":1,"allow_usb":1}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"allow_disabling_cellular_data\":1,\"allow_non_market_app_instal\":1,\"allow_data_while_roaming\":1,\"allow_camera\":1,\"allow_bluetooth\":4,\"external_storage_encryption\":2,\"allow_storage_encryption\":2,\"allow_app_auto_sync\":1,\"allow_background_data\":1,\"allow_usb\":1}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"allow_disabling_cellular_data\":1,\"allow_non_market_app_instal\":1,\"allow_data_while_roaming\":1,\"allow_camera\":1,\"allow_bluetooth\":4,\"external_storage_encryption\":2,\"allow_storage_encryption\":2,\"allow_app_auto_sync\":1,\"allow_background_data\":1,\"allow_usb\":1}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("allow_non_market_app_instal","1");
    data.put("allow_disabling_cellular_data","1");
    data.put("allow_app_auto_sync","1");
    data.put("allow_data_while_roaming","1");
    data.put("allow_background_data","1");
    data.put("allow_bluetooth","1");
    data.put("allow_usb","1");
    data.put("allow_camera","1");
    data.put("allow_storage_encryption","1");
    data.put("external_storage_encryption","1");
    data.put("allow_nfc","1");
    data.put("allow_disabling_gps","1");
    data.put("allow_microphone","1");
    data.put("allow_bluetooth_tethering","1");
    data.put("allow_wifi","1");
    data.put("allow_whitelist_wifi_only","1");
    data.put("allow_wifi_tethering","1");
    data.put("allow_usb_tethering","1");
    data.put("allow_tethering","1");
    data.put("allow_usb_debug","1");
    data.put("allow_sd_card","1");
    data.put("allow_sd_card_write","1");
    data.put("allow_clipboard","1");
    data.put("allow_google_crash_report","1");
    data.put("allow_mock_location","1");
    data.put("allow_settings","1");
    data.put("allow_factory_reset","1");
    data.put("allow_wallpaper_change","1");
    data.put("allow_statusbar_expansion","1");
    data.put("allow_ota_upgrade","1");
    data.put("allow_vpn","1");
    data.put("allow_screen_capture","1");
    data.put("allow_power_off","1");
    data.put("allow_usb_media_player","1");
    data.put("allow_android_market","1");
    data.put("allow_non_market_apps","1");
    data.put("allow_personal_space_non_market_apps","1");
    data.put("allow_you_tube","1");
    data.put("allow_voice_dialer","1");
    data.put("allow_install_app","1");
    data.put("allow_uninstall_app","1");
    data.put("allow_android_browser","1");
    data.put("browser_allow_fraud_warning","1");
    data.put("browser_allow_popups","1");
    data.put("browser_allow_javascript","1");
    data.put("browser_allow_autofill","1");
    data.put("browser_allow_cookies","1");
    data.put("allow_roaming_sync","1");
    data.put("allow_roaming_voice_calls","1");
    data.put("allow_roaming_push","1");
    data.put("allow_roaming_data","1");
    data.put("allow_s_voice","1");
    data.put("allow_stop_system_app","1");
    data_disable_clear_storage_and_force_stop_apps=List();
    data_disable_clear_storage_and_force_stop_apps_item1=Map();
    data_disable_clear_storage_and_force_stop_apps_item1.put("group_display_name","value");
    data_disable_clear_storage_and_force_stop_apps_item1.put("app_id","1");
    data_disable_clear_storage_and_force_stop_apps.add(data_disable_clear_storage_and_force_stop_apps_item1);
    data.put("disable_clear_storage_and_force_stop_apps",data_disable_clear_storage_and_force_stop_apps);
    data.put("allow_app_control","1");
    data.put("allow_clear_app_data_and_force_stop","1");
    data.put("allow_airplane_mode","1");
    data.put("allow_android_beam","1");
    data.put("allow_background_process_limit","1");
    data.put("allow_s_beam","1");
    data.put("allow_wifi_direct","1");
    data.put("allow_headphone","1");
    data.put("allow_smart_clip_mode","1");
    data.put("allow_clipboard_share","1");
    data.put("allow_firmware_recovery","1");
    data.put("allow_sdcard_move","1");
    data.put("allow_safe_mode","1");
    data.put("allow_home_key","1");
    data.put("allow_lock_screen_menu","1");
    data.put("allow_developer_mode","1");
    data.put("allow_kill_activity_on_leave","1");
    data.put("allow_lock_screen_view","1");
    data.put("allow_share_list","1");
    data.put("allow_play_protect_monitoring","1");
    data.put("allow_user_mobile_data_limit","1");
    data.put("allow_date_time_change","1");
    data.put("allow_google_account_auto_sync","1");
    data.put("allow_user_profile","1");
    data.put("allow_app_notification_mode","1");
    data.put("allow_audio_record","1");
    data.put("allow_video_record","1");
    data.put("allow_usb_host_storage","1");
    data.put("allow_use_network_time","1");
    data.put("allow_gmail","1");
    data.put("allow_google_maps","1");
    data.put("allow_bt_discoverable","1");
    data.put("allow_bt_pairing","1");
    data.put("allow_bt_outgoing_calls","1");
    data.put("allow_bt_pc_connection","1");
    data.put("allow_bt_data_transfer","1");
    data.put("allow_emergency_calls_only","1");
    data.put("allow_mms","1");
    data.put("allow_incoming_mms","1");
    data.put("allow_outgoing_mms","1");
    data.put("allow_sms","1");
    data.put("allow_incoming_sms","1");
    data.put("allow_outgoing_sms","1");
    data.put("allow_call","1");
    data.put("allow_outgoing_call","1");
    data.put("allow_incoming_call","1");
    data.put("allow_user_add_accounts","1");
    data_restricted_account_types=List();
    data_restricted_account_types.add("value");
    data.put("restricted_account_types",data_restricted_account_types);
    data.put("allow_personal_accounts_in_playstore",true);
    data.put("allow_s_finder","1");
    data.put("allow_air_command","1");
    data.put("allow_air_view","1");
    data.put("app_permission_policy","1");
    data.put("allow_timezone","value");
    data.put("allow_ambient_display",true);
    data.put("allow_brightness_config",true);
    data.put("adaptive_brightness",true);
    data.put("brightness_value","1");
    data.put("allow_date_time_settings",true);
    data.put("allow_config_screen_timeout",true);
    data.put("screen_timeout","1");
    data.put("allow_printing",true);
    data.put("allow_non_secure_keypad","1");
    data.put("allow_contact_to_device","1");
    data.put("allow_knox_app_store","1");
    data.put("allow_keyguard_camera","1");
    data.put("allow_keyguard_notifications","1");
    data.put("set_roaming_always_on",true);
    data.put("allow_data_saver",true);
    data.put("allow_data_saver_restriction",true);
    data.put("allow_cert_based_authentication_for_managed_apps",true);
    data.put("allow_install_or_modify_certificates",true);
    data.put("allow_secured_wifi","1");
    data.put("allow_auto_fill_service",true);
    data.put("allow_all_apps_access","1");
    data.put("allow_usb_file_transfer",true);
    data.put("allow_personal_space_screen_capture",true);
    data.put("allow_personal_space_camera",true);
    data.put("app_filter_type","1");
    data_apps_list=List();
    data_apps_list_item1=Map();
    data_apps_list_item1.put("group_display_name","value");
    data_apps_list_item1.put("app_id","1");
    data_apps_list.add(data_apps_list_item1);
    data.put("apps_list",data_apps_list);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"allow_disabling_cellular_data":1,"allow_non_market_app_instal":1,"allow_data_while_roaming":1,"allow_camera":1,"allow_bluetooth":4,"external_storage_encryption":2,"allow_storage_encryption":2,"allow_app_auto_sync":1,"allow_background_data":1,"allow_usb":1}'

Sample Request Body

Add Restrictions payload to the profile

Copied!

  {
    "allow_disabling_cellular_data": 1,
    "allow_non_market_app_instal": 1,
    "allow_data_while_roaming": 1,
    "allow_camera": 1,
    "allow_bluetooth": 4,
    "external_storage_encryption": 2,
    "allow_storage_encryption": 2,
    "allow_app_auto_sync": 1,
    "allow_background_data": 1,
    "allow_usb": 1
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

allow_non_market_app_instalinteger

Whether installing apps from non-market sources is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_disabling_cellular_datainteger

Whether disabling cellular data is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_app_auto_syncinteger

Whether app auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_data_while_roaminginteger

Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_background_datainteger

Whether background data usage is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bluetoothinteger

Whether Bluetooth is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_usbinteger

Whether USB connectivity is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_camerainteger

Whether the camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_storage_encryptioninteger

Whether storage encryption enforcement is configured. 0 = Allow encryption, 1 = Disable encryption, 2 = Not Configured. Default: 2

external_storage_encryptioninteger

Whether external storage encryption is required. 0 = Not Required, 1 = Required, 2 = Not Configured. Default: 2

allow_nfcinteger

Whether NFC is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_disabling_gpsinteger

Whether disabling GPS is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_microphoneinteger

Whether the microphone is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bluetooth_tetheringinteger

Whether Bluetooth tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wifiinteger

Whether Wi-Fi is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4

allow_whitelist_wifi_onlyinteger

Whether only allowlisted Wi-Fi networks are permitted. 0 = All networks allowed, 1 = Allowlisted only. Default: 0

allow_wifi_tetheringinteger

Whether Wi-Fi tethering (hotspot) is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_tetheringinteger

Whether USB tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_tetheringinteger

Whether tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_debuginteger

Whether USB debugging is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sd_cardinteger

Whether SD card access is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sd_card_writeinteger

Whether writing to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_clipboardinteger

Whether clipboard access is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_crash_reportinteger

Whether Google crash reports are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_mock_locationinteger

Whether mock locations are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_settingsinteger

Whether access to device settings is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_factory_resetinteger

Whether factory reset is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wallpaper_changeinteger

Whether wallpaper changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_statusbar_expansioninteger

Whether status bar expansion is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_ota_upgradeinteger

Whether OTA upgrades are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_vpninteger

Whether VPN is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_screen_captureinteger

Whether screen capture is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_power_offinteger

Whether powering off the device is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_media_playerinteger

Whether USB media player is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_marketinteger

Whether the Android Market (Play Store) is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_non_market_appsinteger

Whether non-market apps are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_personal_space_non_market_appsinteger

Whether non-market apps in personal space are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_you_tubeinteger

Whether YouTube is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_voice_dialerinteger

Whether the voice dialer is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_install_appinteger

Whether app installation is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_uninstall_appinteger

Whether app uninstallation is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_browserinteger

Whether the Android browser is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_fraud_warninginteger

Whether browser fraud warnings are allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_popupsinteger

Whether browser popups are allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_javascriptinteger

Whether browser JavaScript is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_autofillinteger

Whether browser autofill is allowed. 0 = Restricted, 1 = Allowed. Default: 1

browser_allow_cookiesinteger

Whether browser cookies are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_syncinteger

Whether sync while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_voice_callsinteger

Whether voice calls while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_pushinteger

Whether push notifications while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_roaming_datainteger

Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_s_voiceinteger

Whether S Voice is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_stop_system_appinteger

Whether stopping system apps is allowed. 0 = Restricted, 1 = Allowed. Default: 1

disable_clear_storage_and_force_stop_appsJSON Array

List of apps excluded from clear storage and force stop restrictions

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

allow_app_controlinteger

Whether app control restrictions are enabled. 0 = Disabled, 1 = Enabled. Default: 1

allow_clear_app_data_and_force_stopinteger

Whether clearing app data and force stopping apps is allowed. 0 = Restricted, 1 = Allowed, 2 = Restrict Specific Apps. Default: 1

allow_airplane_modeinteger

Whether airplane mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_android_beaminteger

Whether Android Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_background_process_limitinteger

Whether background process limit is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_s_beaminteger

Whether S Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_wifi_directinteger

Whether Wi-Fi Direct is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_headphoneinteger

Whether headphone use is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_smart_clip_modeinteger

Whether Smart Clip mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_clipboard_shareinteger

Whether clipboard sharing is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_firmware_recoveryinteger

Whether firmware recovery is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_sdcard_moveinteger

Whether moving apps to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_safe_modeinteger

Whether safe mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_home_keyinteger

Whether the home key is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_lock_screen_menuinteger

Whether the lock screen menu is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_developer_modeinteger

Whether developer mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_kill_activity_on_leaveinteger

Whether killing activities on leave is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_lock_screen_viewinteger

Whether the lock screen view is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_share_listinteger

Whether the share list is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_play_protect_monitoringinteger

Whether Google Play Protect monitoring is allowed. 0 = Restricted, 1 = Allowed. Default: 0

allow_user_mobile_data_limitinteger

Whether the user can set mobile data limits. 0 = Restricted, 1 = Allowed. Default: 1

allow_date_time_changeinteger

Whether changing date and time is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_account_auto_syncinteger

Whether Google account auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_user_profileinteger

Whether user profiles are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_app_notification_modeinteger

Whether app notification mode changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_audio_recordinteger

Whether audio recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_video_recordinteger

Whether video recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_usb_host_storageinteger

Whether USB host storage is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_use_network_timeinteger

Whether using network time is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_gmailinteger

Whether Gmail is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_google_mapsinteger

Whether Google Maps is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_discoverableinteger

Whether Bluetooth discoverable mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_pairinginteger

Whether Bluetooth pairing is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_outgoing_callsinteger

Whether Bluetooth outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_pc_connectioninteger

Whether Bluetooth PC connections are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_bt_data_transferinteger

Whether Bluetooth data transfer is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_emergency_calls_onlyinteger

Whether emergency calls only mode is enforced. 0 = Restricted, 1 = Allowed. Default: 1

allow_mmsinteger

Whether MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_mmsinteger

Whether incoming MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_mmsinteger

Whether outgoing MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_smsinteger

Whether SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_smsinteger

Whether incoming SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_smsinteger

Whether outgoing SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_callinteger

Whether phone calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_outgoing_callinteger

Whether outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_incoming_callinteger

Whether incoming calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_user_add_accountsinteger

Whether the user can add accounts. 0 = Restricted, 1 = Allowed. Default: 1

restricted_account_typesJSON Array

List of restricted account type identifiers

Show Sub-Attributes

string

allow_personal_accounts_in_playstoreboolean

Whether personal accounts are allowed in the Play Store. Default: true

allow_s_finderinteger

Whether S Finder is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_air_commandinteger

Whether Air Command is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_air_viewinteger

Whether Air View is allowed. 0 = Restricted, 1 = Allowed. Default: 1

app_permission_policyinteger

Global runtime permission policy. 0 = Prompt, 1 = Auto Grant, 2 = Auto Deny, 4 = Not Configured. Default: 4

allow_timezonestring

Timezone identifier to enforce (e.g., America/New_York). Empty = User Controlled

allow_ambient_displayboolean

Whether ambient display (always-on display) is enabled. Default: true

allow_brightness_configboolean

Whether the user can configure screen brightness. Default: true

adaptive_brightnessboolean

Whether adaptive brightness is enabled. Default: true

brightness_valueinteger

Screen brightness level (0-255). Default: 126

allow_date_time_settingsboolean

Whether the user can change date and time settings. Default: true

allow_config_screen_timeoutboolean

Whether the user can configure screen timeout. Default: true

screen_timeoutinteger

Screen timeout duration in seconds. Default: 5

allow_printingboolean

Whether printing is allowed. Default: true

allow_non_secure_keypadinteger

Whether the non-secure keypad is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_contact_to_deviceinteger

Whether contact sync to device is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_knox_app_storeinteger

Whether the Knox App Store is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_keyguard_camerainteger

Whether the keyguard camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_keyguard_notificationsinteger

Keyguard notification visibility level. 0 = Show All, 1 = Hide Sensitive, 2 = Hide All. Default: 0

set_roaming_always_onboolean

Whether data roaming is forced to always on. Default: false

allow_data_saverboolean

Whether Data Saver mode is allowed. Default: false

allow_data_saver_restrictionboolean

Whether Data Saver restriction is enabled. Default: false

allow_cert_based_authentication_for_managed_appsboolean

Whether certificate-based authentication is allowed for managed apps. Default: true

allow_install_or_modify_certificatesboolean

Whether the user can install or modify certificates. Default: true

allow_secured_wifiinteger

Whether secured Wi-Fi is allowed. 0 = Restricted, 1 = Allowed. Default: 1

allow_auto_fill_serviceboolean

Whether the autofill service is allowed. Default: false

allow_all_apps_accessinteger

Whether all apps are accessible in Managed Google Play. 0 = Restricted, 1 = Allowed. Default: 0

allow_usb_file_transferboolean

Whether USB file transfer is allowed. Default: true

allow_personal_space_screen_captureboolean

Whether screen capture is allowed in the personal space. Default: true

allow_personal_space_cameraboolean

Whether the camera is allowed in the personal space. Default: true

app_filter_typeinteger

App filtering mode. -1 = Not Configured. Default: -1

apps_listJSON Array

List of apps for the app filter

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Restrictions payload successfully added

Copied!

  {
    "payload_id": 9007199254741000,
    "allow_disabling_cellular_data": 1,
    "allow_non_market_app_instal": 1,
    "allow_data_while_roaming": 1,
    "allow_camera": 1,
    "allow_bluetooth": 4,
    "external_storage_encryption": 2,
    "allow_storage_encryption": 2,
    "allow_app_auto_sync": 1,
    "allow_background_data": 1,
    "allow_usb": 1
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.