Retrieve the full configuration details of a Shared Device Configuration 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 Shared Device Configuration payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/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 Payload Item IDs response

- Query Parameters

includestringOptional

Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned

Sample Request

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

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

Full configuration details of Shared Device Configuration payload item

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