Add a new Custom Policy payload configuration to an existing profile

Create Windows Custom Policy payload

Endpoints

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

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/windowscustompolicy

Scope

MDMDeviceMgmt.CREATECopied!

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

syncml_commandsJSON ArrayOptional

Syncml Commands

Show Sub-Attributes

JSON Object

Show Sub-Attributes

loc_uristringOptional

Loc URI for the Custom Configuration

action_typeintegerOptional

Action type 0 - Add, 1 - Replace, 2 - Delete

data_typeintegerOptional

Data type of the Loc URI 0 - INT, 1 - FLOAT, 2 - BOOLEAN, 3 - STRING, 4 - XML, 5 - Base64

datastringOptional

Base64 Encoded Data String

positionintegerOptional

Position of the Payload Item

namestringOptional

Name of the Custom Configuration Item

data_file_idlongOptional

File Id of the Custom Config Data from the API

custom_profile_data_idlongOptional

Unique identifier of the custom profile data record to associate with the payload

is_modifiedbooleanOptional

Read only Field, To indicate whether Item is modified

is_blobbooleanOptional

Indicates whether the custom profile data is stored as a binary blob. true if blob, false if plain text/XML

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowscustompolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"syncml_commands":[{"data":"MA==","action_type":"1","loc_uri":"./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera","data_type":"0","name":"Configuration 1","position":1}]}'

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/windowscustompolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"syncml_commands\":[{\"data\":\"MA==\",\"action_type\":\"1\",\"loc_uri\":\"./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera\",\"data_type\":\"0\",\"name\":\"Configuration 1\",\"position\":1}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"syncml_commands\":[{\"data\":\"MA==\",\"action_type\":\"1\",\"loc_uri\":\"./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera\",\"data_type\":\"0\",\"name\":\"Configuration 1\",\"position\":1}]}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/windowscustompolicy", 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_syncml_commands=List();
    data_syncml_commands_item1=Map();
    data_syncml_commands_item1.put("loc_uri","value");
    data_syncml_commands_item1.put("action_type","1");
    data_syncml_commands_item1.put("data_type","1");
    data_syncml_commands_item1.put("data","value");
    data_syncml_commands_item1.put("position","1");
    data_syncml_commands_item1.put("name","value");
    data_syncml_commands_item1.put("data_file_id","1");
    data_syncml_commands_item1.put("custom_profile_data_id","1");
    data_syncml_commands_item1.put("is_modified",true);
    data_syncml_commands_item1.put("is_blob",true);
    data_syncml_commands.add(data_syncml_commands_item1);
    data.put("syncml_commands",data_syncml_commands);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/windowscustompolicy"
        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/v1/mdm/profiles/{profile_id}/payloads/windowscustompolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"syncml_commands":[{"data":"MA==","action_type":"1","loc_uri":"./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera","data_type":"0","name":"Configuration 1","position":1}]}'

Sample Request Body

Add Custom Policy payload to the profile

Copied!

  {
    "syncml_commands": [
      {
        "data": "MA==",
        "action_type": "1",
        "loc_uri": "./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera",
        "data_type": "0",
        "name": "Configuration 1",
        "position": 1
      }
    ]
  }

▼ 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

syncml_commandsJSON Array

Syncml Commands

Show Sub-Attributes

JSON Object

Show Sub-Attributes

loc_uristring

Loc URI for the Custom Configuration

action_typeinteger

Action type 0 - Add, 1 - Replace, 2 - Delete

data_typeinteger

Data type of the Loc URI 0 - INT, 1 - FLOAT, 2 - BOOLEAN, 3 - STRING, 4 - XML, 5 - Base64

datastring

Base64 Decoded Data String

positioninteger

Position of the Payload Item

namestring

Name of the Custom Configuration Item

data_file_idlong

File Id of the Custom Config Data from the API

custom_profile_data_idlong

Unique identifier of the custom profile data record to associate with the payload

is_modifiedboolean

Read only Field, To indicate whether Item is modified

is_blobboolean

Indicates whether the custom profile data is stored as a binary blob. true if blob, false if plain text/XML

custom_profile_idlong

Custom Profile Id

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Custom Policy payload successfully added

Copied!

  {
    "payload_id": "9007199254741295",
    "syncml_commands": [
      {
        "data": "0",
        "action_type": "1",
        "loc_uri": "./Device/Vendor/MSFT/Policy/Config/Camera/AllowCamera",
        "custom_profile_data_id": "9007199254741070",
        "data_type": "0",
        "name": "Configuration 1",
        "position": "1"
      }
    ],
    "custom_profile_id": "9007199254741071"
  }

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