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

To get Passcode policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/passcodepolicy/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 request on this payload's parent endpoint

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/passcodepolicy/payloaditems/{payload_id} \
  --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

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

Full configuration details of an iOS passcode payload item

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