Add a new Passcode payload configuration to an existing profile

To create Passcode policy

Endpoints

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

Copy full URL

Request URL

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

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

max_passcode_ageintegerOptional

Maximum Passcode Age in days. Allowed values: 1-170

require_alphanumericbooleanOptional

Mandates the use of alphanumeric values as passcode

max_failed_attemptsintegerOptional

Maximum number of failed attempts before factory reset. Allowed values: 3-9

min_passcode_lengthintegerOptional

Minimum passcode length. Allowed values: 1-16

min_complex_charsintegerOptional

Minimum number of special characters in the passcode. Allowed values: 1-4

no_of_passcode_maintainedintegerOptional

Number of passcodes maintained in history. Allowed values: 1-50

allow_simple_valuebooleanOptional

Allow numerical values to be configured as passcode

auto_lock_idle_forintegerOptional

Maximum idle time (minutes) before auto-lock. Allowed values: 1, 2, 3, 4, 5, 10, 15

max_grace_periodintegerOptional

Maximum time (minutes) to unlock device without passcode prompt. Allowed values: 0-240

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/passcodepolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"max_passcode_age":150,"min_passcode_length":5,"require_alphanumeric":true,"min_complex_chars":2,"no_of_passcode_maintained":50,"allow_simple_value":false,"auto_lock_idle_for":3,"max_grace_period":0,"max_failed_attempts":9}'

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/passcodepolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"max_passcode_age\":150,\"min_passcode_length\":5,\"require_alphanumeric\":true,\"min_complex_chars\":2,\"no_of_passcode_maintained\":50,\"allow_simple_value\":false,\"auto_lock_idle_for\":3,\"max_grace_period\":0,\"max_failed_attempts\":9}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"max_passcode_age\":150,\"min_passcode_length\":5,\"require_alphanumeric\":true,\"min_complex_chars\":2,\"no_of_passcode_maintained\":50,\"allow_simple_value\":false,\"auto_lock_idle_for\":3,\"max_grace_period\":0,\"max_failed_attempts\":9}"

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

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/passcodepolicy"
        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/passcodepolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"max_passcode_age":150,"min_passcode_length":5,"require_alphanumeric":true,"min_complex_chars":2,"no_of_passcode_maintained":50,"allow_simple_value":false,"auto_lock_idle_for":3,"max_grace_period":0,"max_failed_attempts":9}'

Sample Request Body

Add an iOS passcode policy payload to the profile

Copied!

  {
    "max_passcode_age": 150,
    "min_passcode_length": 5,
    "require_alphanumeric": true,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "max_failed_attempts": 9
  }

▼ 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

max_passcode_ageinteger

Maximum Passcode Age in days

require_alphanumericboolean

Whether alphanumeric passcode is required

max_failed_attemptsinteger

Maximum failed attempts before factory reset

min_passcode_lengthinteger

Minimum passcode length

min_complex_charsinteger

Minimum special characters in passcode

no_of_passcode_maintainedinteger

Number of passcodes maintained in history

allow_simple_valueboolean

Whether simple (numeric) passcode is allowed

auto_lock_idle_forinteger

Auto-lock idle time in minutes

max_grace_periodinteger

Grace period in minutes before passcode prompt

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Payload successfully added with configuration details

Copied!

  {
    "max_passcode_age": 150,
    "min_passcode_length": 5,
    "payload_id": 9007199254741000,
    "require_alphanumeric": true,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "max_failed_attempts": 9
  }

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