Retrieve restriction settings applied to a managed device

gets the restriction of the device

Endpoints

get /api/v1/mdm/devices/{device_id}/restrictions

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/devices/{device_id}/restrictions

Scope

MDMInventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

device_idstringMandatory

Unique identifier of the device. Obtain from the Get Device List response

- Query Parameters

limitintegerOptional

Maximum number of records to return in a single response. Used together with offset for pagination

skip-tokenstringOptional

Pagination continuation token returned by a previous response. Pass it to fetch the next page of results

offsetintegerOptional

Zero-based index of the first record to return. Used together with limit for pagination

delta-tokenstringOptional

Token used for delta/incremental fetches. Pass the token returned from a previous response to retrieve only items modified since that point

searchkeystringOptional

Value to search for. Must be used in combination with searchfield to specify which field is searched

searchfieldstringOptional

Name of the field to search against. Used together with searchkey (e.g., name, email, udid)

is_allowed_appsbooleanOptional

Set to true to return apps from the allow list, false to return apps from the block list

is_app_purchased_from_portalbooleanOptional

Set to true to restrict results to apps purchased through the enterprise app portal (VPP/managed Google Play). Default: false

searchstringOptional

Free-text search string applied to the default searchable fields of the resource

app_scopestringOptional

Filter applications by their assignment scope. Allowed values: 1=All, 2=Assigned to groups, 3=Assigned to devices

platformstringOptional

Filter results by device platform. Allowed values: 1=iOS, 2=Android, 3=Windows, 4=macOS, 6=tvOS

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/v1/mdm/devices/{device_id}/restrictions?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&searchkey=SOME_STRING_VALUE&searchfield=SOME_STRING_VALUE&is_allowed_apps=SOME_BOOLEAN_VALUE&is_app_purchased_from_portal=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&app_scope=SOME_STRING_VALUE&platform=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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/devices/{device_id}/restrictions?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&searchkey=SOME_STRING_VALUE&searchfield=SOME_STRING_VALUE&is_allowed_apps=SOME_BOOLEAN_VALUE&is_app_purchased_from_portal=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&app_scope=SOME_STRING_VALUE&platform=SOME_STRING_VALUE"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/devices/{device_id}/restrictions?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&searchkey=SOME_STRING_VALUE&searchfield=SOME_STRING_VALUE&is_allowed_apps=SOME_BOOLEAN_VALUE&is_app_purchased_from_portal=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&app_scope=SOME_STRING_VALUE&platform=SOME_STRING_VALUE", headers=headers)

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

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


    parameters = "limit=value" + "&" + "skip-token=value" + "&" + "delta-token=value" + "&" + "searchkey=value" + "&" + "searchfield=value" + "&" + "is_allowed_apps=value" + "&" + "is_app_purchased_from_portal=value" + "&" + "search=value" + "&" + "app_scope=value" + "&" + "platform=value";

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/devices/{device_id}/restrictions" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/devices/{device_id}/restrictions?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&searchkey=SOME_STRING_VALUE&searchfield=SOME_STRING_VALUE&is_allowed_apps=SOME_BOOLEAN_VALUE&is_app_purchased_from_portal=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&app_scope=SOME_STRING_VALUE&platform=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

allow_inapp_purchaseinteger

In-app purchase: 0 - Restricted, 1 - Allowed

allow_app_removalinteger

App removal: 0 - Restricted, 1 - Allowed

allow_newsinteger

News: 0 - Restricted, 1 - Allowed

allow_profile_installationinteger

Profile installation: 0 - Restricted, 1 - Allowed

allow_airdropinteger

AirDrop: 0 - Restricted, 1 - Allowed

allow_cloud_backupinteger

Cloud backup: 0 - Restricted, 1 - Allowed

allow_assistantinteger

Siri: 0 - Restricted, 1 - Allowed

allow_safariinteger

Safari browser: 0 - Restricted, 1 - Allowed

camerainteger

Camera (Windows/Android): 0 - Restricted, 1 - Allowed

bluetoothinteger

Bluetooth (Windows): 0 - Restricted, 1 - Allowed

browserinteger

Browser (Windows): 0 - Restricted, 1 - Allowed

copy_pasteinteger

Copy/paste (Windows): 0 - Restricted, 1 - Allowed

screen_captureinteger

Screen capture (Windows): 0 - Restricted, 1 - Allowed

allow_autofillinteger

Browser autofill: 0 - Restricted, 1 - Allowed

allow_cookiesinteger

Browser cookies: 0 - Restricted, 1 - Allowed

allow_popupsinteger

Browser pop-ups: 0 - Allowed, 1 - Restricted

knox_restricionsJSON Object

Samsung Knox-specific restriction settings

Show Sub-Attributes

allow_camerastring

Knox camera restriction: 1 - Allowed, 0 - Restricted, -1 - Not applicable

allow_wifistring

Knox Wi-Fi restriction: 1 - Allowed, 0 - Restricted, -1 - Not applicable

allow_bluetoothstring

Knox Bluetooth restriction: 1 - Allowed, 0 - Restricted, -1 - Not applicable

allow_screen_capturestring

Knox screen capture restriction: 1 - Allowed, 0 - Restricted, -1 - Not applicable

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

iOS, Android, Windows, and Knox restriction settings

Copied!

  {
    "knox_restricions": {
      "allow_camera": "1",
      "allow_wifi": "-1",
      "allow_bluetooth": "-1",
      "allow_screen_capture": "0"
    },
    "allow_assistant": 1,
    "allow_popups": 0,
    "allow_safari": 1,
    "allow_inapp_purchase": 0,
    "allow_cloud_backup": 1,
    "allow_app_removal": 1,
    "allow_airdrop": 0,
    "allow_news": 0,
    "allow_cookies": 1,
    "bluetooth": 0,
    "copy_paste": 0,
    "allow_autofill": 0,
    "browser": 1,
    "screen_capture": 0,
    "allow_profile_installation": 0,
    "camera": 1
  }

▼ Show full

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