Modify the configuration of a Passcode payload item within a profile

Modify Windows Passcode policy payload

Endpoints

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

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/windowspasscodepolicy/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

pwd_enabledintegerOptional

Pwd Enabled. Default: 0

allow_simple_pwdintegerOptional

Allow Simple Pwd. Default: -1

min_pwd_lengthintegerOptional

Min Pwd Length. Default: -1

alphanumeric_pwd_requiredintegerOptional

Alphanumeric Pwd Required. Default: -1

pwd_expirationintegerOptional

Pwd Expiration. Default: -1

pwd_historyintegerOptional

Pwd History. Default: -1

max_pwd_failed_attemptsintegerOptional

Max Pwd Failed Attempts. Default: -1

max_inactivity_time_devlockintegerOptional

Max Inactivity Time Devlock. Default: -1

min_pwd_complex_charintegerOptional

Min Pwd Complex Char. Default: -1

min_pwd_ageintegerOptional

Min Pwd Age. Default: -1

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowspasscodepolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"alphanumeric_pwd_required":-1,"min_pwd_length":-1,"pwd_enabled":0,"pwd_expiration":-1,"max_pwd_failed_attempts":-1,"max_inactivity_time_devlock":-1,"min_pwd_complex_char":-1,"pwd_history":-1,"allow_simple_pwd":-1,"min_pwd_age":-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/windowspasscodepolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"alphanumeric_pwd_required\":-1,\"min_pwd_length\":-1,\"pwd_enabled\":0,\"pwd_expiration\":-1,\"max_pwd_failed_attempts\":-1,\"max_inactivity_time_devlock\":-1,\"min_pwd_complex_char\":-1,\"pwd_history\":-1,\"allow_simple_pwd\":-1,\"min_pwd_age\":-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 = "{\"alphanumeric_pwd_required\":-1,\"min_pwd_length\":-1,\"pwd_enabled\":0,\"pwd_expiration\":-1,\"max_pwd_failed_attempts\":-1,\"max_inactivity_time_devlock\":-1,\"min_pwd_complex_char\":-1,\"pwd_history\":-1,\"allow_simple_pwd\":-1,\"min_pwd_age\":-1}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/windowspasscodepolicy/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("pwd_enabled","1");
    data.put("allow_simple_pwd","1");
    data.put("min_pwd_length","1");
    data.put("alphanumeric_pwd_required","1");
    data.put("pwd_expiration","1");
    data.put("pwd_history","1");
    data.put("max_pwd_failed_attempts","1");
    data.put("max_inactivity_time_devlock","1");
    data.put("min_pwd_complex_char","1");
    data.put("min_pwd_age","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/windowspasscodepolicy/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/windowspasscodepolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"alphanumeric_pwd_required":-1,"min_pwd_length":-1,"pwd_enabled":0,"pwd_expiration":-1,"max_pwd_failed_attempts":-1,"max_inactivity_time_devlock":-1,"min_pwd_complex_char":-1,"pwd_history":-1,"allow_simple_pwd":-1,"min_pwd_age":-1}'

Sample Request Body

Modify Passcode payload item

Copied!

  {
    "alphanumeric_pwd_required": -1,
    "min_pwd_length": -1,
    "pwd_enabled": 0,
    "pwd_expiration": -1,
    "max_pwd_failed_attempts": -1,
    "max_inactivity_time_devlock": -1,
    "min_pwd_complex_char": -1,
    "pwd_history": -1,
    "allow_simple_pwd": -1,
    "min_pwd_age": -1
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

pwd_enabledinteger

Pwd Enabled. Default: 0

allow_simple_pwdinteger

Allow Simple Pwd. Default: -1

min_pwd_lengthinteger

Min Pwd Length. Default: -1

alphanumeric_pwd_requiredinteger

Alphanumeric Pwd Required. Default: -1

pwd_expirationinteger

Pwd Expiration. Default: -1

pwd_historyinteger

Pwd History. Default: -1

max_pwd_failed_attemptsinteger

Max Pwd Failed Attempts. Default: -1

max_inactivity_time_devlockinteger

Max Inactivity Time Devlock. Default: -1

min_pwd_complex_charinteger

Min Pwd Complex Char. Default: -1

min_pwd_ageinteger

Min Pwd Age. Default: -1

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Passcode payload item successfully modified

Copied!

  {
    "alphanumeric_pwd_required": -1,
    "min_pwd_length": -1,
    "payload_id": 9007199254741000,
    "pwd_enabled": 0,
    "pwd_expiration": -1,
    "max_pwd_failed_attempts": -1,
    "max_inactivity_time_devlock": -1,
    "min_pwd_complex_char": -1,
    "pwd_history": -1,
    "allow_simple_pwd": -1,
    "min_pwd_age": -1
  }

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