Retrieve the details of a specific Windows Lockdown (Kiosk) Policy

Get the lockdown policy details

Endpoints

get /api/mdm/profiles/lockdown/policies/{policy_id}

Copy full URL

Request URL

https://{serverurl}/api/mdm/profiles/lockdown/policies/{policy_id}

Scope

MDMOnDemand.MDMDeviceMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

policy_idstringMandatory

Unique identifier of the lockdown policy. Obtain from the Create Lockdown Policy response

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/mdm/profiles/lockdown/policies/{policy_id} \
  --header 'Authorization: Zoho-oauthtoken  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/mdm/profiles/lockdown/policies/{policy_id}"))
        .header("Authorization", "Zoho-oauthtoken  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 = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/mdm/profiles/lockdown/policies/{policy_id}", headers=headers)

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

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


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

    response = invokeUrl
    [
        url: "https://appDomain/api/mdm/profiles/lockdown/policies/{policy_id}"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/mdm/profiles/lockdown/policies/{policy_id}' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

policy_idstring

Unique ID of the lockdown policy

configurationJSON object

Lockdown policy configuration settings

Show Sub-Attributes

associated_userstring

User account name for whom Kiosk mode is enabled

create_userboolean

Automatically create the associated user account on the device (kioskuser0). Default: true

auto_logon_appstring

AUMID / Folder path of the app launched automatically at user login

kiosk_typeinteger

Kiosk mode type. 1 - Multi-app, 2 - Single-app, 3 - Edge browser

explorer_restrictioninteger

File Explorer access restriction level. 1 - Complete, 2 - Downloads only, 3 - Removable only, 4 - Downloads and Removable, 5 - No restriction

show_taskbarboolean

Show the Taskbar in Multi-app Kiosk mode (Not applicable to windows 11). Default: true

auto_distribute_appsstring

(Deprcated) Auto Distribute Kiosk Apps

webclip_propertiesJSON object

WebClip Related Propeties like name, id, URL

Show Sub-Attributes

edge_idle_timeoutinteger

Idle timeout in minutes before Edge browser resets

edge_kiosk_typeinteger

Edge kiosk type. 1 - Digital Signage, 2 - Public Browsing. Default: 2

appconfigJSON object

Container for allowed apps configuration

Show Sub-Attributes

allowed_appsJSON array

Array of bundle/package identifiers for apps that are permitted by this policy

Show Sub-Attributes

JSON object

Show Sub-Attributes

app_identifierstring

Identifier / Path of the App to be allowed in Kiosk

app_typestring

Type of the App 1 - Modenr App (UWP), 2 - Legacy (Win32)

is_background_appstring

Whether the App is Foreground or Background

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full lockdown policy details (Multi app)

Copied!

  {
    "policy_id": "9007199254741003",
    "configuration": {
      "show_taskbar": true,
      "group_display_name": "Camera",
      "auto_distribute_apps": true,
      "auto_logon_app": "Microsoft.WindowsCamera_8wekyb3d8bbwe!App",
      "kiosk_type": "1",
      "create_user": true,
      "associated_user": "Kiosk",
      "explorer_restriction": "5"
    },
    "appconfig": {
      "allowed_apps": [
        {
          "group_display_name": "Camera",
          "app_type": "1",
          "app_identifier": "Microsoft.WindowsCamera_8wekyb3d8bbwe!App",
          "is_background_app": false
        },
        {
          "app_type": "2",
          "app_identifier": "%windir%\\system32\\calc.exe",
          "is_background_app": false
        },
        {
          "app_type": "2",
          "app_identifier": "%windir%\\system32\\cmd.exe",
          "is_background_app": true
        }
      ]
    }
  }

▼ Show full

Full lockdown Edge policy details

Copied!

  {
    "policy_id": "9007199254741003",
    "configuration": {
      "show_taskbar": true,
      "auto_distribute_apps": false,
      "webclip_properties": {
        "webclip_url": "%windir%\\system32\\calc.exe",
        "webclip_policy_id": "1",
        "webclip_name": "t1"
      },
      "edge_kiosk_type": "1",
      "kiosk_type": "3",
      "create_user": true,
      "edge_idle_timeout": "0",
      "associated_user": "Kiosk",
      "explorer_restriction": "1"
    },
    "appconfig": {
      "allowed_apps": [
        {
          "app_type": "2",
          "app_identifier": "%ProgramFiles(x86)%\\Microsoft\\Edge\\Application\\msedge.exe",
          "is_background_app": false
        }
      ]
    }
  }

▼ Show full

Full lockdown Single App policy details

Copied!

  {
    "policy_id": "9007199254741003",
    "configuration": {
      "show_taskbar": true,
      "auto_distribute_apps": false,
      "kiosk_type": "2",
      "create_user": true,
      "associated_user": "Kiosk",
      "explorer_restriction": "1"
    },
    "appconfig": {
      "allowed_apps": [
        {
          "group_display_name": "Calculator",
          "app_type": "1",
          "app_identifier": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
          "is_background_app": false
        }
      ]
    }
  }

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