Modify the configuration of a Firmware Password payload item within a profile

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 modify Mac Firmware Password policy payload item

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword/payloaditems/{payload_id}

Scope

MDMOnDemand.MDMDeviceMgmt.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- 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
firmware_password_typeintegerMandatory

Firmware password mode. Allowed values: 1=Set static password, 2=Set dynamic password, 3=Turn Off Firmware password

firmware_new_passwordstringOptional

Firmware New Password

firmware_old_passwordstringOptional

Firmware Old Password

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"firmware_password_type":1}'
▼ Show full

Sample Request Body

Modify Firmware Password payload item

Copied!
  {
    "firmware_old_password": 6967000001030042,
    "firmware_password_type": 1,
    "firmware_new_password": 6967000001030048
  }
                
▼ Show full

Response Parameters

- HTTP code 200

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

Unique identifier of the payload item

firmware_password_typeinteger

Firmware password mode. Allowed values: 1=Set static password, 2=Set dynamic password, 3=Turn Off Firmware password

firmware_new_passwordstring

Firmware New Password

firmware_old_passwordstring

Firmware Old Password

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Firmware Password payload item successfully modified

Copied!
  {
    "payload_id": 6967000001030044,
    "firmware_password_type": "1",
    "firmware_new_password": "6967000001030042"
  }
                
▼ 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.