Configure a new Windows Lockdown (Kiosk) Policy

Store Windows Kiosk payload's Meta Data

Endpoints

post /api/mdm/profiles/lockdown

Copy full URL

Request URL

https://{server-hostname}:8383/api/mdm/profiles/lockdown

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

policy_namestringMandatory

Name of the lockdown policy

policy_descstringOptional

Description for the lockdown policy

allowed_appsJSON ArrayOptional

List of apps allowed in Kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

app_identifierstringOptional

Identifier / Path of the App to be allowed in Kiosk

app_typestringOptional

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

is_background_appstringOptional

Whether the App is Foreground or Background

configurationJSON ObjectOptional

Configuration settings for the lockdown policy

Show Sub-Attributes

associated_userstringMandatory

User account name for whom Kiosk mode is enabled

create_userbooleanOptional

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

auto_logon_appstringOptional

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

kiosk_typeintegerOptional

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

explorer_restrictionintegerOptional

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

show_taskbarbooleanOptional

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

edge_configurationJSON ObjectOptional

Edge browser kiosk configuration

Show Sub-Attributes

home_page_urlsJSON ArrayOptional

List of home page URLs for Edge browser kiosk

Show Sub-Attributes

JSON Object

Show Sub-Attributes

home_page_url_idlongOptional

ID from the Response of [WebClip API]

edge_idle_timeoutintegerOptional

Idle timeout in minutes before Edge browser resets

edge_kiosk_typeintegerOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/mdm/profiles/lockdown \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"policy_desc":"test desc","configuration":{"show_taskbar":true,"auto_distribute_apps":true,"auto_logon_app":"Microsoft.WindowsCamera_8wekyb3d8bbwe!App","kiosk_type":"1","create_user":true,"associated_user":"Kiosk","explorer_restriction":"5"},"allowed_apps":[{"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}],"policy_name":"test lockdown policy"}'

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"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"policy_desc\":\"test desc\",\"configuration\":{\"show_taskbar\":true,\"auto_distribute_apps\":true,\"auto_logon_app\":\"Microsoft.WindowsCamera_8wekyb3d8bbwe!App\",\"kiosk_type\":\"1\",\"create_user\":true,\"associated_user\":\"Kiosk\",\"explorer_restriction\":\"5\"},\"allowed_apps\":[{\"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}],\"policy_name\":\"test lockdown policy\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"policy_desc\":\"test desc\",\"configuration\":{\"show_taskbar\":true,\"auto_distribute_apps\":true,\"auto_logon_app\":\"Microsoft.WindowsCamera_8wekyb3d8bbwe!App\",\"kiosk_type\":\"1\",\"create_user\":true,\"associated_user\":\"Kiosk\",\"explorer_restriction\":\"5\"},\"allowed_apps\":[{\"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}],\"policy_name\":\"test lockdown policy\"}"

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

conn.request("POST", "/api/mdm/profiles/lockdown", 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("policy_name","value");
    data.put("policy_desc","value");
    data_allowed_apps=List();
    data_allowed_apps_item1=Map();
    data_allowed_apps_item1.put("app_identifier","value");
    data_allowed_apps_item1.put("app_type","value");
    data_allowed_apps_item1.put("is_background_app","value");
    data_allowed_apps.add(data_allowed_apps_item1);
    data.put("allowed_apps",data_allowed_apps);
    data_configuration=Map();
    data_configuration.put("associated_user","value");
    data_configuration.put("create_user",true);
    data_configuration.put("auto_logon_app","value");
    data_configuration.put("kiosk_type","1");
    data_configuration.put("explorer_restriction","1");
    data_configuration.put("show_taskbar",true);
    data_configuration_edge_configuration=Map();
    data_configuration_edge_configuration_home_page_urls=List();
    data_configuration_edge_configuration_home_page_urls_item1=Map();
    data_configuration_edge_configuration_home_page_urls_item1.put("home_page_url_id","1");
    data_configuration_edge_configuration_home_page_urls.add(data_configuration_edge_configuration_home_page_urls_item1);
    data_configuration_edge_configuration.put("home_page_urls",data_configuration_edge_configuration_home_page_urls);
    data_configuration_edge_configuration.put("edge_idle_timeout","1");
    data_configuration_edge_configuration.put("edge_kiosk_type","1");
    data_configuration.put("edge_configuration",data_configuration_edge_configuration);
    data.put("configuration",data_configuration);

    response = invokeUrl
    [
        url: "https://appDomain/api/mdm/profiles/lockdown"
        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/mdm/profiles/lockdown' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"policy_desc":"test desc","configuration":{"show_taskbar":true,"auto_distribute_apps":true,"auto_logon_app":"Microsoft.WindowsCamera_8wekyb3d8bbwe!App","kiosk_type":"1","create_user":true,"associated_user":"Kiosk","explorer_restriction":"5"},"allowed_apps":[{"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}],"policy_name":"test lockdown policy"}'

Sample Request Body

Create a Windows Lockdown (Multi App Kiosk) Policy

Copied!

  {
    "policy_desc": "test desc",
    "configuration": {
      "show_taskbar": true,
      "auto_distribute_apps": true,
      "auto_logon_app": "Microsoft.WindowsCamera_8wekyb3d8bbwe!App",
      "kiosk_type": "1",
      "create_user": true,
      "associated_user": "Kiosk",
      "explorer_restriction": "5"
    },
    "allowed_apps": [
      {
        "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
      }
    ],
    "policy_name": "test lockdown policy"
  }

▼ Show full

Create a Single App Profile

Copied!

  {
    "policy_desc": "test desc",
    "configuration": {
      "kiosk_type": "2",
      "create_user": true,
      "associated_user": "Kiosk"
    },
    "allowed_apps": [
      {
        "app_type": "1",
        "app_identifier": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
        "is_background_app": false
      }
    ],
    "policy_name": "test lockdown policy"
  }

▼ Show full

Create a Single App Edge Kiosk Profile

Copied!

  {
    "policy_desc": "test desc",
    "configuration": {
      "kiosk_type": "3",
      "create_user": true,
      "associated_user": "Kiosk",
      "edge_configuration": {
        "edge_kiosk_type": "1",
        "home_page_urls": [
          {
            "home_page_url_id": "1"
          }
        ],
        "edge_idle_timeout": 0
      }
    },
    "allowed_apps": [
      {
        "app_type": "2",
        "app_identifier": "%ProgramFiles(x86)%\\Microsoft\\Edge\\Application\\msedge.exe",
        "is_background_app": false
      }
    ],
    "policy_name": "test lockdown policy"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

policy_idstring

Unique ID of the newly created lockdown policy

policy_namestring

Name of the created lockdown policy

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Lockdown policy successfully created

Copied!

  {
    "policy_id": "9007199254741005",
    "policy_name": "test lockdown policy"
  }

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