Modify the configuration of a Directory Binding payload item within a profile

To modify Mac Directory Bind policy payload item

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/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

bind_policy_idlongMandatory

Bind Policy Id. Obtain from the Add Bind Policy Template response

object_namestringOptional

Object Name

adminprivilegeadgrouparrayOptional

List of Active Directory group name strings granted admin privileges

adbindoustringMandatory

Adbindou

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"adbindou":"value","bind_policy_id":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/macdirectorybindpolicy/payloaditems/{payload_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"adbindou\":\"value\",\"bind_policy_id\":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 = "{\"adbindou\":\"value\",\"bind_policy_id\":1}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/payloaditems/{payload_id}", 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("adbindou","value");
    data.put("bind_policy_id","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macdirectorybindpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"adbindou":"value","bind_policy_id":1}'

▼ Show full

Sample Request Body

Modify Directory Binding payload item

Copied!

  {
    "adbindou": "value",
    "object_name": "Zylker User",
    "bind_policy_id": 1,
    "adminprivilegeadgroup": [
      "Domain Admins"
    ]
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

bind_policy_idlong

Bind Policy Id

object_namestring

Object Name

adminprivilegeadgrouparray

List of Active Directory group name strings granted admin privileges

adbindoustring

Adbindou

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Directory Binding payload item successfully modified

Copied!

  {
    "adbindou": "value",
    "payload_id": 9007199254741000,
    "object_name": "Zylker User",
    "bind_policy_id": 1,
    "adminprivilegeadgroup": [
      "Domain Admins"
    ]
  }

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