Add a new Restrictions payload configuration to an existing profile

To create Mac Restrictions policy

Endpoints

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

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/macrestrictionspolicy

Scope

MDMOnDemand.MDMDeviceMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- 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_game_centerbooleanOptional

Allow Game Center. Default: true

allow_modifi_wallpaperbooleanOptional

Allow Modifi Wallpaper. Default: true

allow_use_of_camerabooleanOptional

Allow Use Of Camera. Default: true

allow_cloud_document_syncbooleanOptional

Allow Cloud Document Sync. Default: true

allow_cloud_keychain_syncbooleanOptional

Allow Cloud Keychain Sync. Default: true

allow_touch_idbooleanOptional

Allow Touch Id. Default: true

safari_allow_autofillbooleanOptional

Safari Allow Autofill. Default: true

allow_spotlight_resultbooleanOptional

Allow Spotlight Result. Default: true

force_assist_profanity_filterbooleanOptional

Force Assist Profanity Filter. Default: false

allow_activity_continuationbooleanOptional

Allow Activity Continuation. Default: true

allow_dictionary_lookupbooleanOptional

Allow Dictionary Lookup. Default: true

allow_music_servicebooleanOptional

Allow Music Service. Default: true

allow_screen_capturebooleanOptional

Allow Screen Capture. 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

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_cloud_photo_libbooleanOptional

Allow Cloud Photo Lib. Default: true

request_to_leave_classroombooleanOptional

Request To Leave Classroom. Default: false

allow_content_cachingbooleanOptional

Allow Content Caching. Default: true

allow_itunes_file_sharingbooleanOptional

Allow Itunes File Sharing. Default: true

allow_auto_unlockbooleanOptional

Allow Auto Unlock. Default: true

allow_cloud_desktop_documentbooleanOptional

Allow Cloud Desktop Document. Default: true

allow_cloud_bookmarksbooleanOptional

Allow Cloud Bookmarks. Default: true

allow_cloud_mailbooleanOptional

Allow Cloud Mail. Default: true

allow_cloud_calenderbooleanOptional

Allow Cloud Calender. Default: true

allow_cloud_remindersbooleanOptional

Allow Cloud Reminders. Default: true

allow_cloud_addressbookbooleanOptional

Allow Cloud Addressbook. Default: true

allow_cloud_notesbooleanOptional

Allow Cloud Notes. Default: true

gatekeeper_settingintegerOptional

Gatekeeper app source restriction. Allowed values: 1=App Store Only, 2=App Store and Identified Developers, 3=Anywhere, 4=Not Configured. Default: 4

allow_override_gatekeeperbooleanOptional

Allow Override Gatekeeper. Default: false

allow_dictationbooleanOptional

Allow Dictation. Default: true

allow_assistantbooleanOptional

Allow Assistant. Default: true

allow_use_of_ibookstorebooleanOptional

Allow Use Of Ibookstore. Default: true

allow_ibookstore_erotica_mediabooleanOptional

Allow Ibookstore Erotica Media. Default: true

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_find_my_friendbooleanOptional

Allow Find My Friend. Default: true

allow_find_my_devicebooleanOptional

Allow Find My Device. Default: true

allow_erase_content_settingsbooleanOptional

Allow Erase Content Settings. Default: true

is_rating_enabledbooleanOptional

Is Rating Enabled. Default: false

country_codestringOptional

Country Code. Default: us

allow_cloud_private_relaybooleanOptional

Allow Cloud Private Relay. Default: true

allow_usb_restriction_modebooleanOptional

Allow Usb Restriction Mode. Default: true

allow_universal_controlbooleanOptional

Allow Universal Control. Default: true

allow_profile_installationbooleanOptional

Allow Profile Installation. 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_airdropbooleanOptional

Allow Airdrop. Default: true

allow_bluetooth_modificationbooleanOptional

Allow Bluetooth Modification. Default: true

bluetooth_settingintegerOptional

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

allow_marketplace_app_installationbooleanOptional

Allow Marketplace App Installation. Default: true

allow_web_distribution_app_installationbooleanOptional

Allow Web Distribution App Installation. Default: true

allow_modifi_passcodebooleanOptional

Allow Modifi Passcode. Default: true

allow_diagnostic_submissionbooleanOptional

Allow Diagnostic Submission. Default: True

allow_apple_personalized_adsbooleanOptional

Allow Apple Personalized Ads. Default: True

allow_iphone_mirroringbooleanOptional

Allow Iphone Mirroring. Default: True

allow_modifi_device_namebooleanOptional

Allow Modifi Device Name. Default: True

allow_cloud_freeformbooleanOptional

Allow Cloud Freeform. Default: True

enforced_fingerprint_timeoutlongOptional

Enforced Fingerprint Timeout. Default: 172800

allow_modify_touch_idbooleanOptional

Allow Modify Touch Id. Default: True

allow_printer_sharing_modificationbooleanOptional

Allow Printer Sharing Modification. Default: True

allow_file_sharing_modificationbooleanOptional

Allow File Sharing Modification. Default: True

allow_internet_sharing_modificationbooleanOptional

Allow Internet Sharing Modification. Default: True

allow_bluetooth_sharing_modificationbooleanOptional

Allow Bluetooth Sharing Modification. Default: True

allow_time_machine_backupbooleanOptional

Allow Time Machine Backup. Default: True

allow_multiplayer_gamingbooleanOptional

Allow Multiplayer Gaming. Default: True

allow_local_user_creationbooleanOptional

Allow Local User Creation. Default: True

airplay_incoming_requestbooleanOptional

Airplay Incoming Request. Default: True

allow_account_modificationbooleanOptional

Allow Account Modification. Default: True

allow_ard_remote_management_modificationbooleanOptional

Allow Ard Remote Management Modification. Default: True

allow_startup_disk_modificationbooleanOptional

Allow Startup Disk Modification. Default: True

allow_remote_apple_events_modificationbooleanOptional

Allow Remote Apple Events Modification. Default: True

allow_image_playgroundbooleanOptional

Allow Image Playground. 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

force_delayed_app_software_updatesbooleanOptional

Force Delayed App Software Updates. Default: False

force_delayed_major_software_updatesbooleanOptional

Force Delayed Major Software Updates. Default: False

software_update_delaylongOptional

Software Update Delay. Default: 30

software_update_minor_os_deferred_install_delaylongOptional

Software Update Minor Os Deferred Install Delay. Default: 30

software_update_major_os_deferred_install_delaylongOptional

Software Update Major Os Deferred Install Delay. Default: 30

software_update_non_os_deferred_install_delaylongOptional

Software Update Non Os Deferred Install 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

force_bypass_screen_capture_alertbooleanOptional

Force Bypass Screen Capture Alert. Default: False

allow_media_sharing_modificationbooleanOptional

Allow Media Sharing Modification. Default: False

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_safari_private_browsingbooleanOptional

Allow Safari Private Browsing. Default: True

allow_safari_history_clearingbooleanOptional

Allow Safari History Clearing. Default: True

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macrestrictionspolicy \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

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/macrestrictionspolicy"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/macrestrictionspolicy", 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();

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

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macrestrictionspolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

▼ Show full

Sample Request Body

Add Restrictions payload to the profile

Copied!

  {
    "allow_activity_continuation": true,
    "safari_allow_autofill": true,
    "force_assist_profanity_filter": false,
    "allow_cloud_document_sync": true,
    "allow_game_center": true,
    "allow_use_of_camera": true,
    "allow_touch_id": true,
    "allow_modifi_wallpaper": true,
    "allow_spotlight_result": true,
    "allow_cloud_keychain_sync": 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_game_centerboolean

Allow Game Center. Default: true

allow_modifi_wallpaperboolean

Allow Modifi Wallpaper. Default: true

allow_use_of_cameraboolean

Allow Use Of Camera. Default: true

allow_cloud_document_syncboolean

Allow Cloud Document Sync. Default: true

allow_cloud_keychain_syncboolean

Allow Cloud Keychain Sync. Default: true

allow_touch_idboolean

Allow Touch Id. Default: true

safari_allow_autofillboolean

Safari Allow Autofill. Default: true

allow_spotlight_resultboolean

Allow Spotlight Result. Default: true

force_assist_profanity_filterboolean

Force Assist Profanity Filter. Default: false

allow_activity_continuationboolean

Allow Activity Continuation. Default: true

allow_dictionary_lookupboolean

Allow Dictionary Lookup. Default: true

allow_music_serviceboolean

Allow Music Service. Default: true

allow_screen_captureboolean

Allow Screen Capture. 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

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_cloud_photo_libboolean

Allow Cloud Photo Lib. Default: true

request_to_leave_classroomboolean

Request To Leave Classroom. Default: false

allow_content_cachingboolean

Allow Content Caching. Default: true

allow_itunes_file_sharingboolean

Allow Itunes File Sharing. Default: true

allow_auto_unlockboolean

Allow Auto Unlock. Default: true

allow_cloud_desktop_documentboolean

Allow Cloud Desktop Document. Default: true

allow_cloud_bookmarksboolean

Allow Cloud Bookmarks. Default: true

allow_cloud_mailboolean

Allow Cloud Mail. Default: true

allow_cloud_calenderboolean

Allow Cloud Calender. Default: true

allow_cloud_remindersboolean

Allow Cloud Reminders. Default: true

allow_cloud_addressbookboolean

Allow Cloud Addressbook. Default: true

allow_cloud_notesboolean

Allow Cloud Notes. Default: true

gatekeeper_settinginteger

Gatekeeper app source restriction. Allowed values: 1=App Store Only, 2=App Store and Identified Developers, 3=Anywhere, 4=Not Configured. Default: 4

allow_override_gatekeeperboolean

Allow Override Gatekeeper. Default: false

allow_dictationboolean

Allow Dictation. Default: true

allow_assistantboolean

Allow Assistant. Default: true

allow_use_of_ibookstoreboolean

Allow Use Of Ibookstore. Default: true

allow_ibookstore_erotica_mediaboolean

Allow Ibookstore Erotica Media. Default: true

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_find_my_friendboolean

Allow Find My Friend. Default: true

allow_find_my_deviceboolean

Allow Find My Device. Default: true

allow_erase_content_settingsboolean

Allow Erase Content Settings. Default: true

is_rating_enabledboolean

Is Rating Enabled. Default: false

country_codestring

Country Code. Default: us

allow_cloud_private_relayboolean

Allow Cloud Private Relay. Default: true

allow_usb_restriction_modeboolean

Allow Usb Restriction Mode. Default: true

allow_universal_controlboolean

Allow Universal Control. Default: true

allow_profile_installationboolean

Allow Profile Installation. 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_airdropboolean

Allow Airdrop. Default: true

allow_bluetooth_modificationboolean

Allow Bluetooth Modification. Default: true

bluetooth_settinginteger

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

allow_marketplace_app_installationboolean

Allow Marketplace App Installation. Default: true

allow_web_distribution_app_installationboolean

Allow Web Distribution App Installation. Default: true

allow_modifi_passcodeboolean

Allow Modifi Passcode. Default: true

allow_diagnostic_submissionboolean

Allow Diagnostic Submission. Default: True

allow_apple_personalized_adsboolean

Allow Apple Personalized Ads. Default: True

allow_iphone_mirroringboolean

Allow Iphone Mirroring. Default: True

allow_modifi_device_nameboolean

Allow Modifi Device Name. Default: True

allow_cloud_freeformboolean

Allow Cloud Freeform. Default: True

enforced_fingerprint_timeoutlong

Enforced Fingerprint Timeout. Default: 172800

allow_modify_touch_idboolean

Allow Modify Touch Id. Default: True

allow_printer_sharing_modificationboolean

Allow Printer Sharing Modification. Default: True

allow_file_sharing_modificationboolean

Allow File Sharing Modification. Default: True

allow_internet_sharing_modificationboolean

Allow Internet Sharing Modification. Default: True

allow_bluetooth_sharing_modificationboolean

Allow Bluetooth Sharing Modification. Default: True

allow_time_machine_backupboolean

Allow Time Machine Backup. Default: True

allow_multiplayer_gamingboolean

Allow Multiplayer Gaming. Default: True

allow_local_user_creationboolean

Allow Local User Creation. Default: True

airplay_incoming_requestboolean

Airplay Incoming Request. Default: True

allow_account_modificationboolean

Allow Account Modification. Default: True

allow_ard_remote_management_modificationboolean

Allow Ard Remote Management Modification. Default: True

allow_startup_disk_modificationboolean

Allow Startup Disk Modification. Default: True

allow_remote_apple_events_modificationboolean

Allow Remote Apple Events Modification. Default: True

allow_image_playgroundboolean

Allow Image Playground. 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

force_delayed_app_software_updatesboolean

Force Delayed App Software Updates. Default: False

force_delayed_major_software_updatesboolean

Force Delayed Major Software Updates. Default: False

software_update_delaylong

Software Update Delay. Default: 30

software_update_minor_os_deferred_install_delaylong

Software Update Minor Os Deferred Install Delay. Default: 30

software_update_major_os_deferred_install_delaylong

Software Update Major Os Deferred Install Delay. Default: 30

software_update_non_os_deferred_install_delaylong

Software Update Non Os Deferred Install 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

force_bypass_screen_capture_alertboolean

Force Bypass Screen Capture Alert. Default: False

allow_media_sharing_modificationboolean

Allow Media Sharing Modification. Default: False

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_safari_private_browsingboolean

Allow Safari Private Browsing. Default: True

allow_safari_history_clearingboolean

Allow Safari History Clearing. Default: True

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Restrictions payload successfully added

Copied!

  {
    "allow_activity_continuation": true,
    "payload_id": 9007199254741000,
    "safari_allow_autofill": true,
    "force_assist_profanity_filter": false,
    "allow_cloud_document_sync": true,
    "allow_game_center": true,
    "allow_use_of_camera": true,
    "allow_touch_id": true,
    "allow_modifi_wallpaper": true,
    "allow_spotlight_result": true,
    "allow_cloud_keychain_sync": 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.