Modify the configuration of a Passcode payload item within a profile

To modify Mac Passcode policy payload item

Endpoints

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

Copy full URL

Request URL

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

allow_simple_valuebooleanOptional

Allow Simple Value. Default: true

require_alphanumericbooleanOptional

Require Alphanumeric. Default: false

min_passcode_lengthintegerOptional

Minimum passcode length. Allowed values: 0-16. Default: 0

min_complex_charsintegerOptional

Minimum number of complex (non-alphanumeric) characters. Allowed values: 0-4. Default: 0

max_passcode_ageintegerOptional

Maximum number of days a passcode can remain unchanged. Allowed values: 0-730. Default: 0

auto_lock_idle_forintegerOptional

Auto-lock idle time in minutes. Allowed values: 0-15. Default: 0

no_of_passcode_maintainedintegerOptional

Number of unique passcodes before reuse is allowed. Allowed values: 0-50. Default: 0

max_grace_periodintegerOptional

Maximum grace period in minutes before passcode is required.

max_failed_attemptsintegerOptional

Maximum number of failed passcode attempts before device wipe. Allowed values: 2-11. Default: 11

restrict_passcodebooleanOptional

Restrict Passcode. Default: false

force_passcodebooleanOptional

Force Passcode. Default: true

change_at_next_authbooleanOptional

Change At Next Auth. Default: false

mins_failed_login_resetintegerOptional

Minutes after which failed login count resets. 0 means no reset. Default: 0

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macpasscodepolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"min_passcode_length":-1,"max_passcode_age":0,"require_alphanumeric":false,"min_complex_chars":-1,"restrict_passcode":false,"no_of_passcode_maintained":0,"allow_simple_value":true,"auto_lock_idle_for":-1,"max_grace_period":-1,"max_failed_attempts":-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/macpasscodepolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"min_passcode_length\":-1,\"max_passcode_age\":0,\"require_alphanumeric\":false,\"min_complex_chars\":-1,\"restrict_passcode\":false,\"no_of_passcode_maintained\":0,\"allow_simple_value\":true,\"auto_lock_idle_for\":-1,\"max_grace_period\":-1,\"max_failed_attempts\":-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 = "{\"min_passcode_length\":-1,\"max_passcode_age\":0,\"require_alphanumeric\":false,\"min_complex_chars\":-1,\"restrict_passcode\":false,\"no_of_passcode_maintained\":0,\"allow_simple_value\":true,\"auto_lock_idle_for\":-1,\"max_grace_period\":-1,\"max_failed_attempts\":-1}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/macpasscodepolicy/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("allow_simple_value",true);
    data.put("require_alphanumeric",true);
    data.put("min_passcode_length","1");
    data.put("min_complex_chars","1");
    data.put("max_passcode_age","1");
    data.put("auto_lock_idle_for","1");
    data.put("no_of_passcode_maintained","1");
    data.put("max_grace_period","1");
    data.put("max_failed_attempts","1");
    data.put("restrict_passcode",true);
    data.put("force_passcode",true);
    data.put("change_at_next_auth",true);
    data.put("mins_failed_login_reset","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macpasscodepolicy/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/macpasscodepolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"min_passcode_length":-1,"max_passcode_age":0,"require_alphanumeric":false,"min_complex_chars":-1,"restrict_passcode":false,"no_of_passcode_maintained":0,"allow_simple_value":true,"auto_lock_idle_for":-1,"max_grace_period":-1,"max_failed_attempts":-1}'

Sample Request Body

Modify Passcode payload item

Copied!

  {
    "min_passcode_length": -1,
    "max_passcode_age": 0,
    "require_alphanumeric": false,
    "min_complex_chars": -1,
    "restrict_passcode": false,
    "no_of_passcode_maintained": 0,
    "allow_simple_value": true,
    "auto_lock_idle_for": -1,
    "max_grace_period": -1,
    "max_failed_attempts": -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

allow_simple_valueboolean

Allow Simple Value. Default: true

require_alphanumericboolean

Require Alphanumeric. Default: false

min_passcode_lengthstring

Minimum passcode length. Allowed values: 0-16. Default: 0

min_complex_charsstring

Minimum number of complex (non-alphanumeric) characters. Allowed values: 0-4. Default: 0

max_passcode_agestring

Maximum number of days a passcode can remain unchanged. Allowed values: 0-730. Default: 0

auto_lock_idle_forstring

Auto-lock idle time in minutes. Allowed values: 0-15. Default: 0

no_of_passcode_maintainedstring

Number of unique passcodes before reuse is allowed. Allowed values: 0-50. Default: 0

max_grace_periodstring

Maximum grace period in minutes before passcode is required.

max_failed_attemptsstring

Maximum number of failed passcode attempts before device wipe. Allowed values: 2-11. Default: 11

restrict_passcodeboolean

Restrict Passcode. Default: false

force_passcodeboolean

Force Passcode. Default: true

change_at_next_authboolean

Change At Next Auth. Default: false

mins_failed_login_resetstring

Minutes after which failed login count resets. 0 means no reset. Default: 0

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Passcode payload item successfully modified

Copied!

  {
    "min_passcode_length": -1,
    "max_passcode_age": 0,
    "payload_id": 9007199254741000,
    "require_alphanumeric": false,
    "min_complex_chars": -1,
    "restrict_passcode": false,
    "no_of_passcode_maintained": 0,
    "allow_simple_value": true,
    "auto_lock_idle_for": -1,
    "max_grace_period": -1,
    "max_failed_attempts": -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.