Retrieve the full configuration details of a Passcode payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Android Passcode policy payload

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/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

- Query Parameters

includestringOptional

Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidpasscodepolicy/payloaditems/{payload_id}?include=payloaditems' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the 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

Full configuration details of Passcode payload item

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: 120 | 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.