Modify the configuration of a Shared Device Configuration payload item within a profile

To modify Shared Device Configuration payload item

Endpoints

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

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

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

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

user_allowedintegerOptional

Maximum number of users allowed on shared device. 0 means no limit. Default: 0

idle_time_logoutintegerOptional

Idle time in seconds before auto-logout for regular users. 0 means disabled. Default: 0

max_grace_periodintegerOptional

Maximum grace period in seconds before passcode is required. Allowed values: -1=Not Configured, 0=Immediately, 60, 300, 900, 3600, 14400. Default: -1

diagnostics_submissionintegerOptional

Diagnostics submission setting. Allowed values: 0=Not Configured, 1=Enable, 2=Disable

app_analyticsintegerOptional

App analytics setting. Allowed values: 0=Not Configured, 1=Enable, 2=Disable

online_authentication_grace_periodintegerOptional

Online authentication grace period in days. Default: 0

domainsarrayOptional

List of domain name strings for shared device authentication

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"diagnostics_submission":1,"user_allowed":1,"max_grace_period":-1,"domains":["zylker.com"],"online_authentication_grace_period":-1,"idle_time_logout":0,"app_analytics":2}'

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/shareddeviceconfiguration/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"diagnostics_submission\":1,\"user_allowed\":1,\"max_grace_period\":-1,\"domains\":[\"zylker.com\"],\"online_authentication_grace_period\":-1,\"idle_time_logout\":0,\"app_analytics\":2}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"diagnostics_submission\":1,\"user_allowed\":1,\"max_grace_period\":-1,\"domains\":[\"zylker.com\"],\"online_authentication_grace_period\":-1,\"idle_time_logout\":0,\"app_analytics\":2}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/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("user_allowed","1");
    data.put("idle_time_logout","1");
    data.put("max_grace_period","1");
    data.put("diagnostics_submission","1");
    data.put("app_analytics","1");
    data.put("online_authentication_grace_period","1");
    data_domains=List();
    data.put("domains",data_domains);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id}"
        type: PUT
        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/shareddeviceconfiguration/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"diagnostics_submission":1,"user_allowed":1,"max_grace_period":-1,"domains":["zylker.com"],"online_authentication_grace_period":-1,"idle_time_logout":0,"app_analytics":2}'

Sample Request Body

Modify Shared Device Configuration payload item

Copied!

  {
    "diagnostics_submission": 1,
    "user_allowed": 1,
    "max_grace_period": -1,
    "domains": [
      "zylker.com"
    ],
    "online_authentication_grace_period": -1,
    "idle_time_logout": 0,
    "app_analytics": 2
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

user_allowedinteger

Maximum number of users allowed on shared device. 0 means no limit. Default: 0

idle_time_logoutinteger

Idle time in seconds before auto-logout for regular users. 0 means disabled. Default: 0

max_grace_periodinteger

Maximum grace period in seconds before passcode is required. Allowed values: -1=Not Configured, 0=Immediately, 60, 300, 900, 3600, 14400. Default: -1

diagnostics_submissioninteger

Diagnostics submission setting. Allowed values: 0=Not Configured, 1=Enable, 2=Disable

app_analyticsinteger

App analytics setting. Allowed values: 0=Not Configured, 1=Enable, 2=Disable

online_authentication_grace_periodinteger

Online authentication grace period in days. Default: 0

domainsarray

List of domain name strings for shared device authentication

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Shared Device Configuration payload item successfully modified

Copied!

  {
    "payload_id": 9007199254741000,
    "diagnostics_submission": 1,
    "user_allowed": 1,
    "max_grace_period": -1,
    "domains": [
      "zylker.com"
    ],
    "online_authentication_grace_period": -1,
    "idle_time_logout": 0,
    "app_analytics": 2
  }

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