Retrieve the full configuration details of a Work Data Security 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

Get Android Work data security payload

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidworkdatasecuritypolicy/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

Sample Request

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

allow_share_doc_to_work_profileboolean

Whether sharing documents to the work profile is allowed. Default: false

allow_share_doc_to_personal_appsboolean

Whether sharing documents to personal apps is allowed. Default: false

allow_profile_content_to_other_appsboolean

Whether work profile content can be shared with other apps. Default: false

allow_profile_contact_over_bluetoothboolean

Whether work profile contacts are accessible over Bluetooth. Default: false

allow_profile_app_widgets_to_home_screenboolean

Whether work profile app widgets can be placed on the home screen. Default: false

allow_contact_in_personal_profileboolean

Whether work contacts are visible in the personal profile. Default: false

allow_contact_access_to_personal_appsboolean

Whether personal apps can access work contacts. Default: false

allow_connected_appsinteger

Whether connected apps (cross-profile communication) are allowed. 0 = Not Allowed. Default: 0

allowed_appsJSON Array

List of apps allowed for cross-profile data sharing

Show Sub-Attributes
JSON Object
Show Sub-Attributes
group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

allow_crossprofile_copy_pasteinteger

Whether cross-profile copy-paste is allowed. 0 = Not Allowed. Default: 0

allow_crossprofile_data_sharinginteger

Whether cross-profile data sharing is allowed. 0 = Not Allowed. Default: 0

workprofile_turnoff_timeoutinteger

Work profile auto-turnoff timeout in minutes. 0 = No Timeout. Default: 0

enable_work_profile_system_appsarray

List of system apps enabled in the work profile (values 1-5)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Work Data Security payload item

Copied!
  {
    "allow_crossprofile_copy_paste": 0,
    "payload_id": 9007199254741000,
    "allow_profile_contact_over_bluetooth": false,
    "allow_contact_access_to_personal_apps": false,
    "allow_connected_apps": 0,
    "allow_share_doc_to_personal_apps": false,
    "allow_profile_app_widgets_to_home_screen": false,
    "allowed_apps": [],
    "allow_contact_in_personal_profile": false,
    "allow_profile_content_to_other_apps": false,
    "allow_share_doc_to_work_profile": false
  }
                
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.