Modify the configuration of a Shared PC payload item within a profile

Modify Windows Shared PC policy payload

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/windowssharedpcpolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/windowssharedpcpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.UPDATECopied!

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

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

account_modelintegerOptional

Account Model. Default: 0

deletion_policyintegerOptional

Deletion Policy. Default: 1

disk_level_cachingintegerOptional

Disk Level Caching. Default: 50

disk_level_deletionintegerOptional

Disk Level Deletion. Default: 25

enable_account_managerbooleanOptional

Enable Account Manager. Default: false

enable_shared_pc_modebooleanOptional

Enable Shared Pc Mode. Default: false

inactive_thresholdintegerOptional

Inactive Threshold. Default: 30

enable_shared_pc_mode_with_onedrive_syncbooleanOptional

Enable Shared Pc Mode With Onedrive Sync. Default: false

kiosk_mode_aumidstringOptional

Kiosk Mode Aumid

kiosk_mode_user_tile_display_textstringOptional

Kiosk Mode User Tile Display Text

maintenance_start_timeintegerOptional

Maintenance Start Time. Default: 0

max_pagefile_size_mbintegerOptional

Max Pagefile Size Mb. Default: 1024

restrict_local_storagebooleanOptional

Restrict Local Storage. Default: false

set_edu_policiesbooleanOptional

Set Edu Policies. Default: false

set_power_policiesbooleanOptional

Set Power Policies. Default: false

signin_on_resumebooleanOptional

Signin On Resume. Default: false

sleep_timeoutintegerOptional

Sleep Timeout. Default: 300

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowssharedpcpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"restrict_local_storage":false,"maintenance_start_time":0,"set_edu_policies":true,"sleep_timeout":300,"signin_on_resume":false,"set_power_policies":false,"kiosk_mode_user_tile_display_text":"","kiosk_mode_aumid":"","disk_level_caching":50,"disk_level_deletion":25,"inactive_threshold":30,"account_model":0,"deletion_policy":1,"enable_account_manager":false,"enable_shared_pc_mode":true,"enable_shared_pc_mode_with_onedrive_sync":false,"max_pagefile_size_mb":1024}'

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/windowssharedpcpolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"restrict_local_storage\":false,\"maintenance_start_time\":0,\"set_edu_policies\":true,\"sleep_timeout\":300,\"signin_on_resume\":false,\"set_power_policies\":false,\"kiosk_mode_user_tile_display_text\":\"\",\"kiosk_mode_aumid\":\"\",\"disk_level_caching\":50,\"disk_level_deletion\":25,\"inactive_threshold\":30,\"account_model\":0,\"deletion_policy\":1,\"enable_account_manager\":false,\"enable_shared_pc_mode\":true,\"enable_shared_pc_mode_with_onedrive_sync\":false,\"max_pagefile_size_mb\":1024}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"restrict_local_storage\":false,\"maintenance_start_time\":0,\"set_edu_policies\":true,\"sleep_timeout\":300,\"signin_on_resume\":false,\"set_power_policies\":false,\"kiosk_mode_user_tile_display_text\":\"\",\"kiosk_mode_aumid\":\"\",\"disk_level_caching\":50,\"disk_level_deletion\":25,\"inactive_threshold\":30,\"account_model\":0,\"deletion_policy\":1,\"enable_account_manager\":false,\"enable_shared_pc_mode\":true,\"enable_shared_pc_mode_with_onedrive_sync\":false,\"max_pagefile_size_mb\":1024}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/windowssharedpcpolicy/payloaditems/{payload_id}", 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("account_model","1");
    data.put("deletion_policy","1");
    data.put("disk_level_caching","1");
    data.put("disk_level_deletion","1");
    data.put("enable_account_manager",true);
    data.put("enable_shared_pc_mode",true);
    data.put("inactive_threshold","1");
    data.put("enable_shared_pc_mode_with_onedrive_sync",true);
    data.put("kiosk_mode_aumid","value");
    data.put("kiosk_mode_user_tile_display_text","value");
    data.put("maintenance_start_time","1");
    data.put("max_pagefile_size_mb","1");
    data.put("restrict_local_storage",true);
    data.put("set_edu_policies",true);
    data.put("set_power_policies",true);
    data.put("signin_on_resume",true);
    data.put("sleep_timeout","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/windowssharedpcpolicy/payloaditems/{payload_id}"
        type: PUT
        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/windowssharedpcpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"restrict_local_storage":false,"maintenance_start_time":0,"set_edu_policies":true,"sleep_timeout":300,"signin_on_resume":false,"set_power_policies":false,"kiosk_mode_user_tile_display_text":"","kiosk_mode_aumid":"","disk_level_caching":50,"disk_level_deletion":25,"inactive_threshold":30,"account_model":0,"deletion_policy":1,"enable_account_manager":false,"enable_shared_pc_mode":true,"enable_shared_pc_mode_with_onedrive_sync":false,"max_pagefile_size_mb":1024}'

Sample Request Body

Modify Shared PC payload item

Copied!

  {
    "restrict_local_storage": false,
    "maintenance_start_time": 0,
    "set_edu_policies": true,
    "sleep_timeout": 300,
    "signin_on_resume": false,
    "set_power_policies": false,
    "kiosk_mode_user_tile_display_text": "",
    "kiosk_mode_aumid": "",
    "disk_level_caching": 50,
    "disk_level_deletion": 25,
    "inactive_threshold": 30,
    "account_model": 0,
    "deletion_policy": 1,
    "enable_account_manager": false,
    "enable_shared_pc_mode": true,
    "enable_shared_pc_mode_with_onedrive_sync": false,
    "max_pagefile_size_mb": 1024
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

account_modelinteger

Account Model. Default: 0

deletion_policyinteger

Deletion Policy. Default: 1

disk_level_cachinginteger

Disk Level Caching. Default: 50

disk_level_deletioninteger

Disk Level Deletion. Default: 25

enable_account_managerboolean

Enable Account Manager. Default: false

enable_shared_pc_modeboolean

Enable Shared Pc Mode. Default: false

inactive_thresholdinteger

Inactive Threshold. Default: 30

enable_shared_pc_mode_with_onedrive_syncboolean

Enable Shared Pc Mode With Onedrive Sync. Default: false

kiosk_mode_aumidstring

Kiosk Mode Aumid

kiosk_mode_user_tile_display_textstring

Kiosk Mode User Tile Display Text

maintenance_start_timeinteger

Maintenance Start Time. Default: 0

max_pagefile_size_mbinteger

Max Pagefile Size Mb. Default: 1024

restrict_local_storageboolean

Restrict Local Storage. Default: false

set_edu_policiesboolean

Set Edu Policies. Default: false

set_power_policiesboolean

Set Power Policies. Default: false

signin_on_resumeboolean

Signin On Resume. Default: false

sleep_timeoutinteger

Sleep Timeout. Default: 300

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Shared PC payload item successfully modified

Copied!

  {
    "restrict_local_storage": false,
    "payload_id": "9007199254741295",
    "maintenance_start_time": "0",
    "set_edu_policies": true,
    "sleep_timeout": "300",
    "signin_on_resume": false,
    "set_power_policies": false,
    "kiosk_mode_user_tile_display_text": "",
    "kiosk_mode_aumid": "",
    "disk_level_caching": "50",
    "disk_level_deletion": "25",
    "inactive_threshold": "30",
    "account_model": "0",
    "deletion_policy": "1",
    "enable_account_manager": false,
    "enable_shared_pc_mode": true,
    "enable_shared_pc_mode_with_onedrive_sync": false,
    "max_pagefile_size_mb": "1024"
  }

▼ Show full

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