Add a new Passcode payload configuration to an existing profile

Create Android Passcode Policy payload

Endpoints

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

Copy full URL

Request URL

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

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

passcode_typeintegerOptional

Passcode quality type. -1 = None, 1 = Pattern, 2 = Numeric, 3 = Alphabetic, 4 = Alphanumeric, 5 = Complex. Default: -1

min_passcode_lengthintegerOptional

Minimum passcode length required. -1 = Not Configured. Default: -1

auto_lock_idle_forintegerOptional

Seconds of inactivity before automatic screen lock. 0 = Not Configured. Default: 0

max_failed_attemptsintegerOptional

Maximum failed passcode attempts before device wipe. -1 = Not Configured. Default: -1

max_passcode_ageintegerOptional

Maximum passcode age in days before forced change. 0 = No Expiry. Default: 0

no_of_passcode_maintainedintegerOptional

Number of previous passcodes maintained in history. 0 = No History. Default: 0

min_lower_case_lengthintegerOptional

Minimum number of lowercase characters required

min_non_letter_lengthintegerOptional

Minimum number of non-letter characters required

min_numeric_lengthintegerOptional

Minimum number of numeric characters required

min_symbol_lengthintegerOptional

Minimum number of symbol characters required

min_upper_case_lengthintegerOptional

Minimum number of uppercase characters required

min_letter_lengthintegerOptional

Minimum number of letter characters required

max_charsintegerOptional

Maximum number of characters allowed in the passcode

max_numeric_sequenceintegerOptional

Maximum length of allowed numeric sequence in the passcode

grace_periodintegerOptional

Grace period in minutes before passcode is required after screen lock. Default: 60

allow_fingerprintintegerOptional

Whether fingerprint authentication is allowed. 0 = Restrict, 1 = Allow. Default: 1

allow_iris_scanbooleanOptional

Whether iris scan authentication is allowed. Default: true

allow_face_unlockbooleanOptional

Whether face unlock authentication is allowed. Default: true

allow_one_lockbooleanOptional

Whether unified lock (same lock for device and work profile) is allowed. Default: true

set_default_passcodebooleanOptional

Whether a default passcode is set on the device. Default: false

allow_change_default_passcodebooleanOptional

Whether the user can change the default passcode. Default: true

new_default_passcodestringOptional

Default passcode value (write-only; use new_default_passcode_id for credential ID reads)

scope_for_passcodeintegerOptional

Scope of the passcode policy. 0 = Device, 1 = Work Profile. Default: 0

allow_trust_agentsintegerOptional

Whether Smart Lock trust agents are allowed. 0 = Disallow, 1 = Allow. Default: 1

new_default_passcode_idlongOptional

ID of the saved credential for the default passcode

passcode_complexityintegerOptional

Password complexity level. 1 = Low, 2 = Medium, 3 = High. Default: 1

strong_auth_timeoutintegerOptional

Timeout in seconds before strong authentication is required. 0 = Use Default. Default: 0

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidpasscodepolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"min_passcode_length":-1,"max_passcode_age":0,"passcode_type":-1,"min_lower_case_length":1,"min_non_letter_length":1,"no_of_passcode_maintained":0,"min_symbol_length":1,"auto_lock_idle_for":0,"min_numeric_length":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/androidpasscodepolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"min_passcode_length\":-1,\"max_passcode_age\":0,\"passcode_type\":-1,\"min_lower_case_length\":1,\"min_non_letter_length\":1,\"no_of_passcode_maintained\":0,\"min_symbol_length\":1,\"auto_lock_idle_for\":0,\"min_numeric_length\":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,\"passcode_type\":-1,\"min_lower_case_length\":1,\"min_non_letter_length\":1,\"no_of_passcode_maintained\":0,\"min_symbol_length\":1,\"auto_lock_idle_for\":0,\"min_numeric_length\":1,\"max_failed_attempts\":-1}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidpasscodepolicy", 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("passcode_type","1");
    data.put("min_passcode_length","1");
    data.put("auto_lock_idle_for","1");
    data.put("max_failed_attempts","1");
    data.put("max_passcode_age","1");
    data.put("no_of_passcode_maintained","1");
    data.put("min_lower_case_length","1");
    data.put("min_non_letter_length","1");
    data.put("min_numeric_length","1");
    data.put("min_symbol_length","1");
    data.put("min_upper_case_length","1");
    data.put("min_letter_length","1");
    data.put("max_chars","1");
    data.put("max_numeric_sequence","1");
    data.put("grace_period","1");
    data.put("allow_fingerprint","1");
    data.put("allow_iris_scan",true);
    data.put("allow_face_unlock",true);
    data.put("allow_one_lock",true);
    data.put("set_default_passcode",true);
    data.put("allow_change_default_passcode",true);
    data.put("new_default_passcode","value");
    data.put("scope_for_passcode","1");
    data.put("allow_trust_agents","1");
    data.put("new_default_passcode_id","1");
    data.put("passcode_complexity","1");
    data.put("strong_auth_timeout","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidpasscodepolicy"
        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/androidpasscodepolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"min_passcode_length":-1,"max_passcode_age":0,"passcode_type":-1,"min_lower_case_length":1,"min_non_letter_length":1,"no_of_passcode_maintained":0,"min_symbol_length":1,"auto_lock_idle_for":0,"min_numeric_length":1,"max_failed_attempts":-1}'

Sample Request Body

Add Passcode payload to the profile

Copied!

  {
    "min_passcode_length": -1,
    "max_passcode_age": 0,
    "passcode_type": -1,
    "min_lower_case_length": 1,
    "min_non_letter_length": 1,
    "no_of_passcode_maintained": 0,
    "min_symbol_length": 1,
    "auto_lock_idle_for": 0,
    "min_numeric_length": 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 for the created payload item

passcode_typeinteger

Passcode quality type. -1 = None, 1 = Pattern, 2 = Numeric, 3 = Alphabetic, 4 = Alphanumeric, 5 = Complex. Default: -1

min_passcode_lengthinteger

Minimum passcode length required. -1 = Not Configured. Default: -1

auto_lock_idle_forinteger

Seconds of inactivity before automatic screen lock. 0 = Not Configured. Default: 0

max_failed_attemptsinteger

Maximum failed passcode attempts before device wipe. -1 = Not Configured. Default: -1

max_passcode_ageinteger

Maximum passcode age in days before forced change. 0 = No Expiry. Default: 0

no_of_passcode_maintainedinteger

Number of previous passcodes maintained in history. 0 = No History. Default: 0

min_lower_case_lengthinteger

Minimum number of lowercase characters required

min_non_letter_lengthinteger

Minimum number of non-letter characters required

min_numeric_lengthinteger

Minimum number of numeric characters required

min_symbol_lengthinteger

Minimum number of symbol characters required

min_upper_case_lengthinteger

Minimum number of uppercase characters required

min_letter_lengthinteger

Minimum number of letter characters required

max_charsinteger

Maximum number of characters allowed in the passcode

max_numeric_sequenceinteger

Maximum length of allowed numeric sequence in the passcode

grace_periodinteger

Grace period in minutes before passcode is required after screen lock. Default: 60

allow_fingerprintinteger

Whether fingerprint authentication is allowed. 0 = Restrict, 1 = Allow. Default: 1

allow_iris_scanboolean

Whether iris scan authentication is allowed. Default: true

allow_face_unlockboolean

Whether face unlock authentication is allowed. Default: true

allow_one_lockboolean

Whether unified lock (same lock for device and work profile) is allowed. Default: true

set_default_passcodeboolean

Whether a default passcode is set on the device. Default: false

allow_change_default_passcodeboolean

Whether the user can change the default passcode. Default: true

new_default_passcodestring

Default passcode value (write-only; use new_default_passcode_id for credential ID reads)

scope_for_passcodeinteger

Scope of the passcode policy. 0 = Device, 1 = Work Profile. Default: 0

allow_trust_agentsinteger

Whether Smart Lock trust agents are allowed. 0 = Disallow, 1 = Allow. Default: 1

new_default_passcode_idlong

ID of the saved credential for the default passcode

passcode_complexityinteger

Password complexity level. 1 = Low, 2 = Medium, 3 = High. Default: 1

strong_auth_timeoutinteger

Timeout in seconds before strong authentication is required. 0 = Use Default. Default: 0

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Passcode payload successfully added

Copied!

  {
    "min_passcode_length": -1,
    "max_passcode_age": 0,
    "payload_id": 9007199254741000,
    "passcode_type": -1,
    "min_lower_case_length": 1,
    "min_non_letter_length": 1,
    "no_of_passcode_maintained": 0,
    "min_symbol_length": 1,
    "auto_lock_idle_for": 0,
    "min_numeric_length": 1,
    "max_failed_attempts": -1
  }

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