Add a new Firmware Password payload configuration to an existing profile

To create Mac Firmware password policy

Endpoints

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

Copy full URL

Request URL

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

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

firmware_password_typeintegerMandatory

Firmware password mode. Allowed values: 1=Static Password, 2=Dynamic Password, 3=Turn Off firmware Password

firmware_new_passwordlongMandatory

Managed password ID for the new firmware/recovery lock password. Create the password first using the Add Managed Password and use the returned managed_password_id

firmware_old_passwordlongOptional

Managed password ID for the current firmware/recovery lock password (required when changing an existing password). Create using the Add Managed Password

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"firmware_password_type":1,"firmware_new_password":6967000001030042}'

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/macfirmwarepassword"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"firmware_password_type\":1,\"firmware_new_password\":6967000001030042}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"firmware_password_type\":1,\"firmware_new_password\":6967000001030042}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword", 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("firmware_password_type","1");
    data.put("firmware_new_password","1");
    data.put("firmware_old_password","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword"
        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/macfirmwarepassword' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"firmware_password_type":1,"firmware_new_password":6967000001030042}'

Sample Request Body

Add Firmware Password payload to the profile

Copied!

  {
    "firmware_password_type": 1,
    "firmware_new_password": 6967000001030042
  }

▼ 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

firmware_password_typestring

Firmware password mode. Values: 1=Static Password, 2=Dynamic Password, 3=Turn Off firmware Password

firmware_new_passwordstring

Managed password ID of the new firmware/recovery lock password that was set

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Firmware Password payload successfully added

Copied!

  {
    "payload_id": 6967000001030044,
    "firmware_password_type": "1",
    "firmware_new_password": "6967000001030042"
  }

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