Retrieve the full configuration details of a Restrictions payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Windows restriction payload details

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/windowsrestrictionpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowsrestrictionpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

enforce_device_encriptionboolean

Enforce Device Encription. Default: false

disable_sd_cardboolean

Disable Sd Card. Default: false

allow_use_of_cameraboolean

Allow Use Of Camera. Default: true

allow_screen_captureboolean

Allow Screen Capture. Default: true

allow_storeboolean

Allow Store. Default: true

allow_storage_cardboolean

Allow Storage Card. Default: true

allow_browserboolean

Allow Browser. Default: true

allow_bluetoothboolean

Allow Bluetooth. Default: true

allow_telemetryinteger

Allow Telemetry. Default: 2

allow_nfcboolean

Allow Nfc. Default: true

allow_usbboolean

Allow Usb. Default: true

allow_wifiboolean

Allow Wifi. Default: true

allow_manual_wifi_configboolean

Allow Manual Wifi Config. Default: true

allow_wifi_hotspotboolean

Allow Wifi Hotspot. Default: true

allow_auto_wifi_hotspotboolean

Allow Auto Wifi Hotspot. Default: true

allow_internet_sharingboolean

Allow Internet Sharing. Default: true

allow_vpnboolean

Allow Vpn. Default: true

allow_vpn_roamingboolean

Allow Vpn Roaming. Default: true

allow_vpn_over_datastring

Allow Vpn Over Data. Default: userConfig

allow_vpn_over_data_roamingstring

Allow Vpn Over Data Roaming. Default: userConfig

allow_data_roamingboolean

Allow Data Roaming. Default: true

allow_copy_pasteboolean

Allow Copy Paste. Default: true

allow_locationinteger

Allow Location. Default: true

allow_microsoft_accountboolean

Allow Microsoft Account. Default: true

allow_adding_non_microsoftboolean

Allow Adding Non Microsoft. Default: true

allow_root_certificate_installboolean

Allow Root Certificate Install. Default: true

allow_developer_unlockboolean

Allow Developer Unlock. Default: true

allow_developer_unlock_newstring

Allow Developer Unlock New. Default: userConfig

allow_user_reset_phoneboolean

Allow User Reset Phone. Default: true

allow_action_notificationboolean

Allow Action Notification. Default: true

allow_cortanaboolean

Allow Cortana. Default: true

allow_voice_recordingboolean

Allow Voice Recording. Default: true

allow_save_as_office_filesboolean

Allow Save As Office Files. Default: true

allow_sharing_office_filesboolean

Allow Sharing Office Files. Default: true

allow_sync_my_settingsboolean

Allow Sync My Settings. Default: true

allow_search_use_locationboolean

Allow Search Use Location. Default: true

safe_search_permissionsinteger

Safe Search Permissions. Default: -1

allow_storing_image_searchboolean

Allow Storing Image Search. Default: true

allow_toastboolean

Allow Toast. Default: true

limit_appdata_to_sys_volboolean

Limit Appdata To Sys Vol. Default: false

limit_appinstall_to_sys_volboolean

Limit Appinstall To Sys Vol. Default: false

allow_all_trusted_appsinteger

Allow All Trusted Apps. Default: 65535

allow_appstore_auto_updateinteger

Allow Appstore Auto Update. Default: -999

require_private_store_onlyboolean

Require Private Store Only. Default: false

allow_bluetooth_advertisingboolean

Allow Bluetooth Advertising. Default: true

allow_bluetooth_discoverableboolean

Allow Bluetooth Discoverable. Default: true

allow_bluetooth_prepairingboolean

Allow Bluetooth Prepairing. Default: true

browser_allow_cookiesstring

Browser Allow Cookies. Default: userConfig

browser_allow_donot_trackstring

Browser Allow Donot Track. Default: userConfig

browser_allow_extensionsboolean

Browser Allow Extensions. Default: true

browser_clear_browsing_data_exitinteger

Browser Clear Browsing Data Exit. Default: -999

browser_about_flags_accessboolean

Browser About Flags Access. Default: true

browser_allow_address_bar_dropdownboolean

Browser Allow Address Bar Dropdown. Default: true

browser_allow_flashinteger

Browser Allow Flash. Default: -999

browser_run_flash_automaticallyboolean

Browser Run Flash Automatically. Default: false

browser_allow_autofillinteger

Browser Allow Autofill. Default: -999

browser_allow_popupsinteger

Browser Allow Popups. Default: -999

browser_allow_developer_toolsboolean

Browser Allow Developer Tools. Default: true

browser_home_pagestring

Browser Home Page

browser_allow_inprivateboolean

Browser Allow Inprivate. Default: true

browser_allow_passmgrstring

Browser Allow Passmgr. Default: userConfig

browser_allow_searchsuggeststring

Browser Allow Searchsuggest. Default: userConfig

browser_allow_smartscreenstring

Browser Allow Smartscreen. Default: userConfig

browser_smartscreen_promptstring

Browser Smartscreen Prompt. Default: userConfig

browser_smartscreen_filesstring

Browser Smartscreen Files. Default: userConfig

allow_cellular_datainteger

Allow Cellular Data. Default: 1

allow_vpn_settingboolean

Allow Vpn Setting. Default: true

allow_fips_policyboolean

Allow Fips Policy. Default: false

ms_feedback_notifinteger

Ms Feedback Notif. Default: 0

allow_add_prov_packageboolean

Allow Add Prov Package. Default: true

allow_remove_prov_packageboolean

Allow Remove Prov Package. Default: true

enable_anti_theft_modeinteger

Enable Anti Theft Mode. Default: 1

allow_date_timeboolean

Allow Date Time. Default: true

allow_edit_device_nameboolean

Allow Edit Device Name. Default: true

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Restrictions payload item

Copied!
  {
    "allow_sharing_office_files": true,
    "browser_allow_extensions": true,
    "allow_nfc": true,
    "allow_vpn_over_data": "userConfig",
    "browser_allow_autofill": "-999",
    "allow_all_trusted_apps": "65535",
    "allow_bluetooth_discoverable": true,
    "allow_action_notification": true,
    "allow_appstore_auto_update": "-999",
    "allow_developer_unlock": true,
    "allow_bluetooth_advertising": true,
    "disable_sd_card": false,
    "allow_screen_capture": true,
    "browser_allow_developer_tools": true,
    "allow_microsoft_account": true,
    "allow_cellular_data": "1",
    "allow_use_of_camera": true,
    "browser_allow_address_bar_dropdown": true,
    "browser_home_page": "",
    "allow_data_roaming": true,
    "safe_search_permissions": "-1",
    "allow_user_reset_phone": true,
    "allow_location": "1",
    "allow_vpn_roaming": true,
    "browser_allow_inprivate": true,
    "browser_allow_popups": "-999",
    "allow_search_use_location": true,
    "allow_store": true,
    "allow_sync_my_settings": true,
    "allow_save_as_office_files": true,
    "allow_usb": true,
    "allow_fips_policy": false,
    "allow_storage_card": true,
    "allow_adding_non_microsoft": true,
    "browser_smartscreen_prompt": "userConfig",
    "allow_wifi": true,
    "browser_allow_donot_track": "userConfig",
    "allow_internet_sharing": true,
    "allow_cortana": true,
    "allow_voice_recording": true,
    "limit_appdata_to_sys_vol": false,
    "browser_clear_browsing_data_exit": "-999",
    "enforce_device_encription": false,
    "allow_vpn": true,
    "allow_root_certificate_install": true,
    "allow_bluetooth": true,
    "ms_feedback_notif": "0",
    "allow_telemetry": "2",
    "allow_vpn_setting": true,
    "require_private_store_only": false,
    "browser_allow_passmgr": "userConfig",
    "allow_add_prov_package": true,
    "limit_appinstall_to_sys_vol": false,
    "allow_developer_unlock_new": "userConfig",
    "browser_allow_searchsuggest": "userConfig",
    "payload_id": "9007199254741295",
    "allow_vpn_over_data_roaming": "userConfig",
    "allow_remove_prov_package": true,
    "browser_smartscreen_files": "userConfig",
    "allow_edit_device_name": true,
    "allow_toast": true,
    "allow_storing_image_search": true,
    "enable_anti_theft_mode": "1",
    "browser_allow_flash": "-999",
    "allow_auto_wifi_hotspot": true,
    "allow_date_time": true,
    "allow_manual_wifi_config": false,
    "browser_allow_smartscreen": "userConfig",
    "allow_copy_paste": true,
    "allow_browser": true,
    "browser_allow_cookies": "userConfig",
    "browser_run_flash_automatically": true,
    "browser_about_flags_access": true,
    "allow_wifi_hotspot": true,
    "allow_bluetooth_prepairing": true
  }
                
Show full

Duration: 1 minute | Threshold: 120 | 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.