Add a new Restrictions payload configuration to an existing profile

To create Restrictions policy

Endpoints

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

Copy full URL

Request URL

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

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_app_installationbooleanOptional

Allow App Installation. Default: true

allow_app_removalbooleanOptional

Allow App Removal. Default: true

allow_use_of_camerabooleanOptional

Allow Use Of Camera. Default: true

allow_face_timebooleanOptional

Allow Face Time. Default: true

allow_airdropbooleanOptional

Allow Airdrop. Default: true

allow_imessagebooleanOptional

Allow Imessage. Default: true

allow_modifi_passcodebooleanOptional

Allow Modifi Passcode. Default: true

allow_screen_capturebooleanOptional

Allow Screen Capture. Default: true

allow_sync_while_roamingbooleanOptional

Allow Sync While Roaming. Default: true

allow_assistantbooleanOptional

Allow Assistant. Default: true

allow_assistant_when_lockedbooleanOptional

Allow Assistant When Locked. Default: true

force_assist_profanity_filterbooleanOptional

Force Assist Profanity Filter. Default: false

allow_assistant_user_contentbooleanOptional

Allow Assistant User Content. Default: true

allow_touch_idbooleanOptional

Allow Touch Id. Default: true

allow_passbook_when_lockedbooleanOptional

Allow Passbook When Locked. Default: true

show_control_centerbooleanOptional

Show Control Center. Default: true

show_notification_centerbooleanOptional

Show Notification Center. Default: true

show_today_viewbooleanOptional

Show Today View. Default: true

allow_voice_dialingbooleanOptional

Allow Voice Dialing. Default: true

allow_inapp_purchasebooleanOptional

Allow Inapp Purchase. Default: true

force_istore_pwd_entrybooleanOptional

Force Istore Pwd Entry. Default: false

allow_game_centerbooleanOptional

Allow Game Center. Default: true

allow_multiplayer_gamingbooleanOptional

Allow Multiplayer Gaming. Default: true

allow_add_game_center_friendbooleanOptional

Allow Add Game Center Friend. Default: true

allow_use_of_youtubebooleanOptional

Allow Use Of Youtube. Default: true

allow_use_of_ibookstorebooleanOptional

Allow Use Of Ibookstore. Default: true

allow_ibookstore_erotica_mediabooleanOptional

Allow Ibookstore Erotica Media. Default: true

allow_itunesbooleanOptional

Allow Itunes. Default: true

allow_safaribooleanOptional

Allow Safari. Default: true

safari_allow_autofillbooleanOptional

Safari Allow Autofill. Default: true

safari_force_fraud_warningbooleanOptional

Safari Force Fraud Warning. Default: false

safari_allow_javascriptbooleanOptional

Safari Allow Javascript. Default: true

safari_allow_popupsbooleanOptional

Safari Allow Popups. Default: true

safari_accept_cookiesintegerOptional

Safari cookie acceptance policy. Allowed values: 0=Never, 1=From current website only, 2=Always. Default: 2

allow_cloud_backupbooleanOptional

Allow Cloud Backup. Default: true

allow_cloud_document_syncbooleanOptional

Allow Cloud Document Sync. Default: true

allow_photo_streambooleanOptional

Allow Photo Stream. Default: true

allow_shared_streambooleanOptional

Allow Shared Stream. Default: true

allow_diagnostic_submissionbooleanOptional

Allow Diagnostic Submission. Default: true

allow_untrusted_tls_promptbooleanOptional

Allow Untrusted Tls Prompt. Default: true

allow_ota_pki_updatesbooleanOptional

Allow Ota Pki Updates. Default: true

force_encrypted_backupbooleanOptional

Force Encrypted Backup. Default: false

force_limited_ad_trackingbooleanOptional

Force Limited Ad Tracking. Default: false

allow_profile_installationbooleanOptional

Allow Profile Installation. Default: true

allow_account_modificationbooleanOptional

Allow Account Modification. Default: true

allow_find_my_friends_modbooleanOptional

Allow Find My Friends Mod. Default: true

allow_host_pairingbooleanOptional

Allow Host Pairing. Default: true

allow_app_cellular_databooleanOptional

Allow App Cellular Data. Default: true

allow_open_doc_in_unmanagedbooleanOptional

Allow Open Doc In Unmanaged. Default: true

allow_open_doc_in_managedbooleanOptional

Allow Open Doc In Managed. Default: true

allow_explicit_contentbooleanOptional

Allow Explicit Content. Default: true

is_rating_enabledbooleanOptional

Is Rating Enabled. Default: false

country_codestringOptional

Country Code. Default: us

movies_rating_valueintegerOptional

Movie content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=G, 200=PG, 300=PG-13, 400=R, 500=NC-17, 1000=Allow All Movies. Default: 1000

tv_shows_rating_valueintegerOptional

TV show content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=TV-Y, 200=TV-Y7, 300=TV-G, 400=TV-PG, 500=TV-14, 600=TV-MA, 1000=Allow All TV Shows. Default: 1000

apps_rating_valueintegerOptional

App Store content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=4+, 200=9+, 300=12+, 600=17+, 1000=Allow All Apps. Default: 1000

allow_managed_app_cloud_syncbooleanOptional

Allow Managed App Cloud Sync. Default: true

allow_managed_book_backupbooleanOptional

Allow Managed Book Backup. Default: true

allow_managed_book_syncbooleanOptional

Allow Managed Book Sync. Default: true

allow_activity_continuationbooleanOptional

Allow Activity Continuation. Default: true

allow_erase_content_settingsbooleanOptional

Allow Erase Content Settings. Default: true

allow_enabling_restrictionbooleanOptional

Allow Enabling Restriction. Default: true

allow_spotlight_resultbooleanOptional

Allow Spotlight Result. Default: true

allow_cloud_keychain_syncbooleanOptional

Allow Cloud Keychain Sync. Default: true

force_airplay_outgoing_pwdbooleanOptional

Force Airplay Outgoing Pwd. Default: false

allow_podcastsbooleanOptional

Allow Podcasts. Default: true

allow_dictionary_lookupbooleanOptional

Allow Dictionary Lookup. Default: true

allow_predictive_keyboardbooleanOptional

Allow Predictive Keyboard. Default: true

allow_auto_correctionbooleanOptional

Allow Auto Correction. Default: true

allow_spellcheckbooleanOptional

Allow Spellcheck. Default: true

force_airplay_incoming_pwdbooleanOptional

Force Airplay Incoming Pwd. Default: false

force_watch_wrist_detectbooleanOptional

Force Watch Wrist Detect. Default: false

allow_modify_touch_idbooleanOptional

Allow Modify Touch Id. Default: true

force_airdrop_unmanagedbooleanOptional

Force Airdrop Unmanaged. Default: false

allow_keyboard_shortcutbooleanOptional

Allow Keyboard Shortcut. Default: true

allow_paired_watchbooleanOptional

Allow Paired Watch. Default: true

allow_modifi_device_namebooleanOptional

Allow Modifi Device Name. Default: true

allow_modifi_wallpaperbooleanOptional

Allow Modifi Wallpaper

allow_auto_app_downloadbooleanOptional

Allow Auto App Download. Default: true

allow_managed_app_trustbooleanOptional

Allow Managed App Trust. Default: true

allow_cloud_photo_libbooleanOptional

Allow Cloud Photo Lib. Default: true

allow_music_servicebooleanOptional

Allow Music Service. Default: true

allow_radio_servicebooleanOptional

Allow Radio Service. Default: true

allow_diag_sub_modificationbooleanOptional

Allow Diag Sub Modification. Default: true

allow_bluetooth_modificationbooleanOptional

Allow Bluetooth Modification. Default: true

allow_dictationbooleanOptional

Allow Dictation. Default: true

force_wifi_whitelistingbooleanOptional

Force Wifi Whitelisting. Default: false

allow_newsbooleanOptional

Allow News. Default: true

allow_airprintbooleanOptional

Allow Airprint. Default: true

allow_airprint_credential_storagebooleanOptional

Allow Airprint Credential Storage. Default: true

force_airprint_tlsbooleanOptional

Force Airprint Tls. Default: false

allow_airprint_ibeacon_discoverybooleanOptional

Allow Airprint Ibeacon Discovery. Default: true

allow_vpn_creationbooleanOptional

Allow Vpn Creation. Default: true

allow_classroom_remoteviewbooleanOptional

Allow Classroom Remoteview. Default: true

force_classroom_auto_joinbooleanOptional

Force Classroom Auto Join. Default: false

force_classroom_appdevicelockbooleanOptional

Force Classroom Appdevicelock. Default: false

force_classroom_remoteviewbooleanOptional

Force Classroom Remoteview. Default: false

request_to_leave_classroombooleanOptional

Request To Leave Classroom. Default: false

allow_proximity_for_newdevicebooleanOptional

Allow Proximity For Newdevice. Default: true

authenticate_before_autofillbooleanOptional

Authenticate Before Autofill. Default: false

force_date_timebooleanOptional

Force Date Time. Default: false

time_zonestringOptional

Time Zone. Default: --

allow_password_autofillbooleanOptional

Allow Password Autofill. Default: true

allow_password_proximitybooleanOptional

Allow Password Proximity. Default: true

allow_password_sharingbooleanOptional

Allow Password Sharing. Default: true

allow_managed_write_unmanaged_contactbooleanOptional

Allow Managed Write Unmanaged Contact. Default: false

allow_unmanaged_read_managed_contactbooleanOptional

Allow Unmanaged Read Managed Contact. Default: false

allow_usb_restriction_modebooleanOptional

Allow Usb Restriction Mode. Default: true

bluetooth_settingintegerOptional

Bluetooth setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2

hotspot_settingintegerOptional

Personal hotspot setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2

allow_hotspot_modificationbooleanOptional

Allow Hotspot Modification. Default: true

allow_esim_modificationbooleanOptional

Allow Esim Modification. Default: true

allow_siri_loggingbooleanOptional

Allow Siri Logging. Default: true

allow_continuous_path_keyboardbooleanOptional

Allow Continuous Path Keyboard. Default: true

allow_find_my_friendbooleanOptional

Allow Find My Friend. Default: true

allow_find_my_devicebooleanOptional

Allow Find My Device. Default: true

force_wifi_onbooleanOptional

Force Wifi On. Default: false

allow_usb_file_drivebooleanOptional

Allow Usb File Drive. Default: true

allow_system_app_removalbooleanOptional

Allow System App Removal. Default: true

allow_notification_modificationbooleanOptional

Allow Notification Modification. Default: true

allow_app_clipsbooleanOptional

Allow App Clips. Default: true

allow_apple_personalized_adsbooleanOptional

Allow Apple Personalized Ads. Default: true

allow_cellular_plan_modificationbooleanOptional

Allow Cellular Plan Modification. Default: true

allow_file_network_drive_accessbooleanOptional

Allow File Network Drive Access. Default: true

allow_shared_device_guest_accountbooleanOptional

Allow Shared Device Guest Account. Default: true

allow_nfcbooleanOptional

Allow Nfc. Default: true

allow_unpaired_external_boot_to_recoverybooleanOptional

Allow Unpaired External Boot To Recovery. Default: false

force_on_device_only_dictationbooleanOptional

Force On Device Only Dictation. Default: false

force_on_device_only_translationbooleanOptional

Force On Device Only Translation. Default: false

require_managed_pasteboardbooleanOptional

Require Managed Pasteboard. Default: false

allow_auto_unlockbooleanOptional

Allow Auto Unlock. Default: true

allow_cloud_private_relaybooleanOptional

Allow Cloud Private Relay. Default: true

allow_mail_privacy_protectionbooleanOptional

Allow Mail Privacy Protection. Default: true

allow_rapid_security_response_installationbooleanOptional

Allow Rapid Security Response Installation. Default: true

allow_rapid_security_response_removalbooleanOptional

Allow Rapid Security Response Removal. Default: true

allow_live_voicemailbooleanOptional

Allow Live Voicemail. Default: true

allow_iphone_widgets_on_macbooleanOptional

Allow Iphone Widgets On Mac. Default: true

allow_marketplace_app_installationbooleanOptional

Allow Marketplace App Installation. Default: true

allow_web_distribution_app_installationbooleanOptional

Allow Web Distribution App Installation. Default: true

allow_genmojibooleanOptional

Allow Genmoji. Default: True

allow_image_playgroundbooleanOptional

Allow Image Playground. Default: True

allow_image_wandbooleanOptional

Allow Image Wand. Default: True

allow_iphone_mirroringbooleanOptional

Allow Iphone Mirroring. Default: True

allow_personalized_handwriting_resultsbooleanOptional

Allow Personalized Handwriting Results. Default: True

allow_writing_toolsbooleanOptional

Allow Writing Tools. Default: True

allow_external_intelligence_integrationsbooleanOptional

Allow External Intelligence Integrations. Default: True

force_delayed_software_updatesbooleanOptional

Force Delayed Software Updates. Default: False

software_update_delaylongOptional

Software Update Delay. Default: 30

allow_external_intelligence_integrations_signinbooleanOptional

Allow External Intelligence Integrations Signin. Default: True

allow_mail_summarybooleanOptional

Allow Mail Summary. Default: True

allow_notes_transcription_summarybooleanOptional

Allow Notes Transcription Summary. Default: True

allow_external_intelligence_workspace_idsstringOptional

Allow External Intelligence Workspace Ids

allow_default_browser_modificationbooleanOptional

Allow Default Browser Modification. Default: True

allow_safari_private_browsingbooleanOptional

Allow Safari Private Browsing. Default: True

allow_safari_history_clearingbooleanOptional

Allow Safari History Clearing. Default: True

allowed_camera_restriction_app_idarrayOptional

List of app IDs (long) allowed to use the camera when camera is restricted. Use the app_group_id from the Apps API response

default_browser_app_detailsJSON ObjectOptional

Default Browser App Details

Show Sub-Attributes

default_calling_app_detailsJSON ObjectOptional

Default Calling App Details

Show Sub-Attributes

default_messaging_app_detailsJSON ObjectOptional

Default Messaging App Details

Show Sub-Attributes

allow_rcs_messagingbooleanOptional

Allow Rcs Messaging. Default: True

allow_call_recordingbooleanOptional

Allow Call Recording. Default: True

allow_apps_to_be_lockedbooleanOptional

Allow Apps To Be Locked. Default: True

allow_apps_to_be_hiddenbooleanOptional

Allow Apps To Be Hidden. Default: True

allow_visual_intelligence_summarizationbooleanOptional

Allow Visual Intelligence Summarization. Default: True

allow_apple_intelligence_reportbooleanOptional

Allow Apple Intelligence Report. Default: True

allow_mail_smart_repliesbooleanOptional

Allow Mail Smart Replies. Default: True

allow_safari_summarybooleanOptional

Allow Safari Summary. Default: True

allow_default_calling_app_modificationbooleanOptional

Allow Default Calling App Modification. Default: True

allow_default_messaging_app_modificationbooleanOptional

Allow Default Messaging App Modification. Default: True

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"allow_app_installation":true,"allow_face_time":true,"allow_assistant":true,"allow_modifi_passcode":true,"allow_use_of_camera":true,"allow_app_removal":true,"allow_airdrop":true,"allow_screen_capture":true,"allow_imessage":true,"allow_sync_while_roaming":true}'

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/restrictionspolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"allow_app_installation\":true,\"allow_face_time\":true,\"allow_assistant\":true,\"allow_modifi_passcode\":true,\"allow_use_of_camera\":true,\"allow_app_removal\":true,\"allow_airdrop\":true,\"allow_screen_capture\":true,\"allow_imessage\":true,\"allow_sync_while_roaming\":true}"))
        .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_app_installation\":true,\"allow_face_time\":true,\"allow_assistant\":true,\"allow_modifi_passcode\":true,\"allow_use_of_camera\":true,\"allow_app_removal\":true,\"allow_airdrop\":true,\"allow_screen_capture\":true,\"allow_imessage\":true,\"allow_sync_while_roaming\":true}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy", 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_app_installation",true);
    data.put("allow_app_removal",true);
    data.put("allow_use_of_camera",true);
    data.put("allow_face_time",true);
    data.put("allow_airdrop",true);
    data.put("allow_imessage",true);
    data.put("allow_modifi_passcode",true);
    data.put("allow_screen_capture",true);
    data.put("allow_sync_while_roaming",true);
    data.put("allow_assistant",true);
    data.put("allow_assistant_when_locked",true);
    data.put("force_assist_profanity_filter",true);
    data.put("allow_assistant_user_content",true);
    data.put("allow_touch_id",true);
    data.put("allow_passbook_when_locked",true);
    data.put("show_control_center",true);
    data.put("show_notification_center",true);
    data.put("show_today_view",true);
    data.put("allow_voice_dialing",true);
    data.put("allow_inapp_purchase",true);
    data.put("force_istore_pwd_entry",true);
    data.put("allow_game_center",true);
    data.put("allow_multiplayer_gaming",true);
    data.put("allow_add_game_center_friend",true);
    data.put("allow_use_of_youtube",true);
    data.put("allow_use_of_ibookstore",true);
    data.put("allow_ibookstore_erotica_media",true);
    data.put("allow_itunes",true);
    data.put("allow_safari",true);
    data.put("safari_allow_autofill",true);
    data.put("safari_force_fraud_warning",true);
    data.put("safari_allow_javascript",true);
    data.put("safari_allow_popups",true);
    data.put("safari_accept_cookies","1");
    data.put("allow_cloud_backup",true);
    data.put("allow_cloud_document_sync",true);
    data.put("allow_photo_stream",true);
    data.put("allow_shared_stream",true);
    data.put("allow_diagnostic_submission",true);
    data.put("allow_untrusted_tls_prompt",true);
    data.put("allow_ota_pki_updates",true);
    data.put("force_encrypted_backup",true);
    data.put("force_limited_ad_tracking",true);
    data.put("allow_profile_installation",true);
    data.put("allow_account_modification",true);
    data.put("allow_find_my_friends_mod",true);
    data.put("allow_host_pairing",true);
    data.put("allow_app_cellular_data",true);
    data.put("allow_open_doc_in_unmanaged",true);
    data.put("allow_open_doc_in_managed",true);
    data.put("allow_explicit_content",true);
    data.put("is_rating_enabled",true);
    data.put("country_code","value");
    data.put("movies_rating_value","1");
    data.put("tv_shows_rating_value","1");
    data.put("apps_rating_value","1");
    data.put("allow_managed_app_cloud_sync",true);
    data.put("allow_managed_book_backup",true);
    data.put("allow_managed_book_sync",true);
    data.put("allow_activity_continuation",true);
    data.put("allow_erase_content_settings",true);
    data.put("allow_enabling_restriction",true);
    data.put("allow_spotlight_result",true);
    data.put("allow_cloud_keychain_sync",true);
    data.put("force_airplay_outgoing_pwd",true);
    data.put("allow_podcasts",true);
    data.put("allow_dictionary_lookup",true);
    data.put("allow_predictive_keyboard",true);
    data.put("allow_auto_correction",true);
    data.put("allow_spellcheck",true);
    data.put("force_airplay_incoming_pwd",true);
    data.put("force_watch_wrist_detect",true);
    data.put("allow_modify_touch_id",true);
    data.put("force_airdrop_unmanaged",true);
    data.put("allow_keyboard_shortcut",true);
    data.put("allow_paired_watch",true);
    data.put("allow_modifi_device_name",true);
    data.put("allow_modifi_wallpaper",true);
    data.put("allow_auto_app_download",true);
    data.put("allow_managed_app_trust",true);
    data.put("allow_cloud_photo_lib",true);
    data.put("allow_music_service",true);
    data.put("allow_radio_service",true);
    data.put("allow_diag_sub_modification",true);
    data.put("allow_bluetooth_modification",true);
    data.put("allow_dictation",true);
    data.put("force_wifi_whitelisting",true);
    data.put("allow_news",true);
    data.put("allow_airprint",true);
    data.put("allow_airprint_credential_storage",true);
    data.put("force_airprint_tls",true);
    data.put("allow_airprint_ibeacon_discovery",true);
    data.put("allow_vpn_creation",true);
    data.put("allow_classroom_remoteview",true);
    data.put("force_classroom_auto_join",true);
    data.put("force_classroom_appdevicelock",true);
    data.put("force_classroom_remoteview",true);
    data.put("request_to_leave_classroom",true);
    data.put("allow_proximity_for_newdevice",true);
    data.put("authenticate_before_autofill",true);
    data.put("force_date_time",true);
    data.put("time_zone","value");
    data.put("allow_password_autofill",true);
    data.put("allow_password_proximity",true);
    data.put("allow_password_sharing",true);
    data.put("allow_managed_write_unmanaged_contact",true);
    data.put("allow_unmanaged_read_managed_contact",true);
    data.put("allow_usb_restriction_mode",true);
    data.put("bluetooth_setting","1");
    data.put("hotspot_setting","1");
    data.put("allow_hotspot_modification",true);
    data.put("allow_esim_modification",true);
    data.put("allow_siri_logging",true);
    data.put("allow_continuous_path_keyboard",true);
    data.put("allow_find_my_friend",true);
    data.put("allow_find_my_device",true);
    data.put("force_wifi_on",true);
    data.put("allow_usb_file_drive",true);
    data.put("allow_system_app_removal",true);
    data.put("allow_notification_modification",true);
    data.put("allow_app_clips",true);
    data.put("allow_apple_personalized_ads",true);
    data.put("allow_cellular_plan_modification",true);
    data.put("allow_file_network_drive_access",true);
    data.put("allow_shared_device_guest_account",true);
    data.put("allow_nfc",true);
    data.put("allow_unpaired_external_boot_to_recovery",true);
    data.put("force_on_device_only_dictation",true);
    data.put("force_on_device_only_translation",true);
    data.put("require_managed_pasteboard",true);
    data.put("allow_auto_unlock",true);
    data.put("allow_cloud_private_relay",true);
    data.put("allow_mail_privacy_protection",true);
    data.put("allow_rapid_security_response_installation",true);
    data.put("allow_rapid_security_response_removal",true);
    data.put("allow_live_voicemail",true);
    data.put("allow_iphone_widgets_on_mac",true);
    data.put("allow_marketplace_app_installation",true);
    data.put("allow_web_distribution_app_installation",true);
    data.put("allow_genmoji",true);
    data.put("allow_image_playground",true);
    data.put("allow_image_wand",true);
    data.put("allow_iphone_mirroring",true);
    data.put("allow_personalized_handwriting_results",true);
    data.put("allow_writing_tools",true);
    data.put("allow_external_intelligence_integrations",true);
    data.put("force_delayed_software_updates",true);
    data.put("software_update_delay","1");
    data.put("allow_external_intelligence_integrations_signin",true);
    data.put("allow_mail_summary",true);
    data.put("allow_notes_transcription_summary",true);
    data.put("allow_external_intelligence_workspace_ids","value");
    data.put("allow_default_browser_modification",true);
    data.put("allow_safari_private_browsing",true);
    data.put("allow_safari_history_clearing",true);
    data_allowed_camera_restriction_app_id=List();
    data.put("allowed_camera_restriction_app_id",data_allowed_camera_restriction_app_id);
    data_default_browser_app_details=Map();
    data.put("default_browser_app_details",data_default_browser_app_details);
    data_default_calling_app_details=Map();
    data.put("default_calling_app_details",data_default_calling_app_details);
    data_default_messaging_app_details=Map();
    data.put("default_messaging_app_details",data_default_messaging_app_details);
    data.put("allow_rcs_messaging",true);
    data.put("allow_call_recording",true);
    data.put("allow_apps_to_be_locked",true);
    data.put("allow_apps_to_be_hidden",true);
    data.put("allow_visual_intelligence_summarization",true);
    data.put("allow_apple_intelligence_report",true);
    data.put("allow_mail_smart_replies",true);
    data.put("allow_safari_summary",true);
    data.put("allow_default_calling_app_modification",true);
    data.put("allow_default_messaging_app_modification",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy"
        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/restrictionspolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"allow_app_installation":true,"allow_face_time":true,"allow_assistant":true,"allow_modifi_passcode":true,"allow_use_of_camera":true,"allow_app_removal":true,"allow_airdrop":true,"allow_screen_capture":true,"allow_imessage":true,"allow_sync_while_roaming":true}'

Sample Request Body

Add Restrictions payload to the profile

Copied!

  {
    "allow_app_installation": true,
    "allow_face_time": true,
    "allow_assistant": true,
    "allow_modifi_passcode": true,
    "allow_use_of_camera": true,
    "allow_app_removal": true,
    "allow_airdrop": true,
    "allow_screen_capture": true,
    "allow_imessage": true,
    "allow_sync_while_roaming": true
  }

▼ 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_app_installationboolean

Allow App Installation. Default: true

allow_app_removalboolean

Allow App Removal. Default: true

allow_use_of_cameraboolean

Allow Use Of Camera. Default: true

allow_face_timeboolean

Allow Face Time. Default: true

allow_airdropboolean

Allow Airdrop. Default: true

allow_imessageboolean

Allow Imessage. Default: true

allow_modifi_passcodeboolean

Allow Modifi Passcode. Default: true

allow_screen_captureboolean

Allow Screen Capture. Default: true

allow_sync_while_roamingboolean

Allow Sync While Roaming. Default: true

allow_assistantboolean

Allow Assistant. Default: true

allow_assistant_when_lockedboolean

Allow Assistant When Locked. Default: true

force_assist_profanity_filterboolean

Force Assist Profanity Filter. Default: false

allow_assistant_user_contentboolean

Allow Assistant User Content. Default: true

allow_touch_idboolean

Allow Touch Id. Default: true

allow_passbook_when_lockedboolean

Allow Passbook When Locked. Default: true

show_control_centerboolean

Show Control Center. Default: true

show_notification_centerboolean

Show Notification Center. Default: true

show_today_viewboolean

Show Today View. Default: true

allow_voice_dialingboolean

Allow Voice Dialing. Default: true

allow_inapp_purchaseboolean

Allow Inapp Purchase. Default: true

force_istore_pwd_entryboolean

Force Istore Pwd Entry. Default: false

allow_game_centerboolean

Allow Game Center. Default: true

allow_multiplayer_gamingboolean

Allow Multiplayer Gaming. Default: true

allow_add_game_center_friendboolean

Allow Add Game Center Friend. Default: true

allow_use_of_youtubeboolean

Allow Use Of Youtube. Default: true

allow_use_of_ibookstoreboolean

Allow Use Of Ibookstore. Default: true

allow_ibookstore_erotica_mediaboolean

Allow Ibookstore Erotica Media. Default: true

allow_itunesboolean

Allow Itunes. Default: true

allow_safariboolean

Allow Safari. Default: true

safari_allow_autofillboolean

Safari Allow Autofill. Default: true

safari_force_fraud_warningboolean

Safari Force Fraud Warning. Default: false

safari_allow_javascriptboolean

Safari Allow Javascript. Default: true

safari_allow_popupsboolean

Safari Allow Popups. Default: true

safari_accept_cookiesinteger

Safari cookie acceptance policy. Allowed values: 0=Never, 1=From current website only, 2=Always. Default: 2

allow_cloud_backupboolean

Allow Cloud Backup. Default: true

allow_cloud_document_syncboolean

Allow Cloud Document Sync. Default: true

allow_photo_streamboolean

Allow Photo Stream. Default: true

allow_shared_streamboolean

Allow Shared Stream. Default: true

allow_diagnostic_submissionboolean

Allow Diagnostic Submission. Default: true

allow_untrusted_tls_promptboolean

Allow Untrusted Tls Prompt. Default: true

allow_ota_pki_updatesboolean

Allow Ota Pki Updates. Default: true

force_encrypted_backupboolean

Force Encrypted Backup. Default: false

force_limited_ad_trackingboolean

Force Limited Ad Tracking. Default: false

allow_profile_installationboolean

Allow Profile Installation. Default: true

allow_account_modificationboolean

Allow Account Modification. Default: true

allow_find_my_friends_modboolean

Allow Find My Friends Mod. Default: true

allow_host_pairingboolean

Allow Host Pairing. Default: true

allow_app_cellular_databoolean

Allow App Cellular Data. Default: true

allow_open_doc_in_unmanagedboolean

Allow Open Doc In Unmanaged. Default: true

allow_open_doc_in_managedboolean

Allow Open Doc In Managed. Default: true

allow_explicit_contentboolean

Allow Explicit Content. Default: true

is_rating_enabledboolean

Is Rating Enabled. Default: false

country_codestring

Country Code. Default: us

movies_rating_valueinteger

Movie content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=G, 200=PG, 300=PG-13, 400=R, 500=NC-17, 1000=Allow All Movies. Default: 1000

tv_shows_rating_valueinteger

TV show content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=TV-Y, 200=TV-Y7, 300=TV-G, 400=TV-PG, 500=TV-14, 600=TV-MA, 1000=Allow All TV Shows. Default: 1000

apps_rating_valueinteger

App Store content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=4+, 200=9+, 300=12+, 600=17+, 1000=Allow All Apps. Default: 1000

allow_managed_app_cloud_syncboolean

Allow Managed App Cloud Sync. Default: true

allow_managed_book_backupboolean

Allow Managed Book Backup. Default: true

allow_managed_book_syncboolean

Allow Managed Book Sync. Default: true

allow_activity_continuationboolean

Allow Activity Continuation. Default: true

allow_erase_content_settingsboolean

Allow Erase Content Settings. Default: true

allow_enabling_restrictionboolean

Allow Enabling Restriction. Default: true

allow_spotlight_resultboolean

Allow Spotlight Result. Default: true

allow_cloud_keychain_syncboolean

Allow Cloud Keychain Sync. Default: true

force_airplay_outgoing_pwdboolean

Force Airplay Outgoing Pwd. Default: false

allow_podcastsboolean

Allow Podcasts. Default: true

allow_dictionary_lookupboolean

Allow Dictionary Lookup. Default: true

allow_predictive_keyboardboolean

Allow Predictive Keyboard. Default: true

allow_auto_correctionboolean

Allow Auto Correction. Default: true

allow_spellcheckboolean

Allow Spellcheck. Default: true

force_airplay_incoming_pwdboolean

Force Airplay Incoming Pwd. Default: false

force_watch_wrist_detectboolean

Force Watch Wrist Detect. Default: false

allow_modify_touch_idboolean

Allow Modify Touch Id. Default: true

force_airdrop_unmanagedboolean

Force Airdrop Unmanaged. Default: false

allow_keyboard_shortcutboolean

Allow Keyboard Shortcut. Default: true

allow_paired_watchboolean

Allow Paired Watch. Default: true

allow_modifi_device_nameboolean

Allow Modifi Device Name. Default: true

allow_modifi_wallpaperboolean

Allow Modifi Wallpaper

allow_auto_app_downloadboolean

Allow Auto App Download. Default: true

allow_managed_app_trustboolean

Allow Managed App Trust. Default: true

allow_cloud_photo_libboolean

Allow Cloud Photo Lib. Default: true

allow_music_serviceboolean

Allow Music Service. Default: true

allow_radio_serviceboolean

Allow Radio Service. Default: true

allow_diag_sub_modificationboolean

Allow Diag Sub Modification. Default: true

allow_bluetooth_modificationboolean

Allow Bluetooth Modification. Default: true

allow_dictationboolean

Allow Dictation. Default: true

force_wifi_whitelistingboolean

Force Wifi Whitelisting. Default: false

allow_newsboolean

Allow News. Default: true

allow_airprintboolean

Allow Airprint. Default: true

allow_airprint_credential_storageboolean

Allow Airprint Credential Storage. Default: true

force_airprint_tlsboolean

Force Airprint Tls. Default: false

allow_airprint_ibeacon_discoveryboolean

Allow Airprint Ibeacon Discovery. Default: true

allow_vpn_creationboolean

Allow Vpn Creation. Default: true

allow_classroom_remoteviewboolean

Allow Classroom Remoteview. Default: true

force_classroom_auto_joinboolean

Force Classroom Auto Join. Default: false

force_classroom_appdevicelockboolean

Force Classroom Appdevicelock. Default: false

force_classroom_remoteviewboolean

Force Classroom Remoteview. Default: false

request_to_leave_classroomboolean

Request To Leave Classroom. Default: false

allow_proximity_for_newdeviceboolean

Allow Proximity For Newdevice. Default: true

authenticate_before_autofillboolean

Authenticate Before Autofill. Default: false

force_date_timeboolean

Force Date Time. Default: false

time_zonestring

Time Zone. Default: --

allow_password_autofillboolean

Allow Password Autofill. Default: true

allow_password_proximityboolean

Allow Password Proximity. Default: true

allow_password_sharingboolean

Allow Password Sharing. Default: true

allow_managed_write_unmanaged_contactboolean

Allow Managed Write Unmanaged Contact. Default: false

allow_unmanaged_read_managed_contactboolean

Allow Unmanaged Read Managed Contact. Default: false

allow_usb_restriction_modeboolean

Allow Usb Restriction Mode. Default: true

bluetooth_settinginteger

Bluetooth setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2

hotspot_settinginteger

Personal hotspot setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2

allow_hotspot_modificationboolean

Allow Hotspot Modification. Default: true

allow_esim_modificationboolean

Allow Esim Modification. Default: true

allow_siri_loggingboolean

Allow Siri Logging. Default: true

allow_continuous_path_keyboardboolean

Allow Continuous Path Keyboard. Default: true

allow_find_my_friendboolean

Allow Find My Friend. Default: true

allow_find_my_deviceboolean

Allow Find My Device. Default: true

force_wifi_onboolean

Force Wifi On. Default: false

allow_usb_file_driveboolean

Allow Usb File Drive. Default: true

allow_system_app_removalboolean

Allow System App Removal. Default: true

allow_notification_modificationboolean

Allow Notification Modification. Default: true

allow_app_clipsboolean

Allow App Clips. Default: true

allow_apple_personalized_adsboolean

Allow Apple Personalized Ads. Default: true

allow_cellular_plan_modificationboolean

Allow Cellular Plan Modification. Default: true

allow_file_network_drive_accessboolean

Allow File Network Drive Access. Default: true

allow_shared_device_guest_accountboolean

Allow Shared Device Guest Account. Default: true

allow_nfcboolean

Allow Nfc. Default: true

allow_unpaired_external_boot_to_recoveryboolean

Allow Unpaired External Boot To Recovery. Default: false

force_on_device_only_dictationboolean

Force On Device Only Dictation. Default: false

force_on_device_only_translationboolean

Force On Device Only Translation. Default: false

require_managed_pasteboardboolean

Require Managed Pasteboard. Default: false

allow_auto_unlockboolean

Allow Auto Unlock. Default: true

allow_cloud_private_relayboolean

Allow Cloud Private Relay. Default: true

allow_mail_privacy_protectionboolean

Allow Mail Privacy Protection. Default: true

allow_rapid_security_response_installationboolean

Allow Rapid Security Response Installation. Default: true

allow_rapid_security_response_removalboolean

Allow Rapid Security Response Removal. Default: true

allow_live_voicemailboolean

Allow Live Voicemail. Default: true

allow_iphone_widgets_on_macboolean

Allow Iphone Widgets On Mac. Default: true

allow_marketplace_app_installationboolean

Allow Marketplace App Installation. Default: true

allow_web_distribution_app_installationboolean

Allow Web Distribution App Installation. Default: true

allow_genmojiboolean

Allow Genmoji. Default: True

allow_image_playgroundboolean

Allow Image Playground. Default: True

allow_image_wandboolean

Allow Image Wand. Default: True

allow_iphone_mirroringboolean

Allow Iphone Mirroring. Default: True

allow_personalized_handwriting_resultsboolean

Allow Personalized Handwriting Results. Default: True

allow_writing_toolsboolean

Allow Writing Tools. Default: True

allow_external_intelligence_integrationsboolean

Allow External Intelligence Integrations. Default: True

force_delayed_software_updatesboolean

Force Delayed Software Updates. Default: False

software_update_delaylong

Software Update Delay. Default: 30

allow_external_intelligence_integrations_signinboolean

Allow External Intelligence Integrations Signin. Default: True

allow_mail_summaryboolean

Allow Mail Summary. Default: True

allow_notes_transcription_summaryboolean

Allow Notes Transcription Summary. Default: True

allow_external_intelligence_workspace_idsstring

Allow External Intelligence Workspace Ids

allow_default_browser_modificationboolean

Allow Default Browser Modification. Default: True

allow_safari_private_browsingboolean

Allow Safari Private Browsing. Default: True

allow_safari_history_clearingboolean

Allow Safari History Clearing. Default: True

allowed_camera_restriction_app_idarray

List of app IDs (long) allowed to use the camera when camera is restricted. Use the app_group_id from the Apps API response

default_browser_app_detailsJSON Object

Default Browser App Details

Show Sub-Attributes

default_calling_app_detailsJSON Object

Default Calling App Details

Show Sub-Attributes

default_messaging_app_detailsJSON Object

Default Messaging App Details

Show Sub-Attributes

allow_rcs_messagingboolean

Allow Rcs Messaging. Default: True

allow_call_recordingboolean

Allow Call Recording. Default: True

allow_apps_to_be_lockedboolean

Allow Apps To Be Locked. Default: True

allow_apps_to_be_hiddenboolean

Allow Apps To Be Hidden. Default: True

allow_visual_intelligence_summarizationboolean

Allow Visual Intelligence Summarization. Default: True

allow_apple_intelligence_reportboolean

Allow Apple Intelligence Report. Default: True

allow_mail_smart_repliesboolean

Allow Mail Smart Replies. Default: True

allow_safari_summaryboolean

Allow Safari Summary. Default: True

allow_default_calling_app_modificationboolean

Allow Default Calling App Modification. Default: True

allow_default_messaging_app_modificationboolean

Allow Default Messaging App Modification. Default: True

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Restrictions payload successfully added

Copied!

  {
    "payload_id": 9007199254741000,
    "allow_app_installation": true,
    "allow_face_time": true,
    "allow_assistant": true,
    "allow_modifi_passcode": true,
    "allow_use_of_camera": true,
    "allow_app_removal": true,
    "allow_airdrop": true,
    "allow_screen_capture": true,
    "allow_imessage": true,
    "allow_sync_while_roaming": true
  }

▼ 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.