Modify the configuration of a Work Data Security payload item within a profile

Modify Android Work data security policy payload

Endpoints

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

Copy full URL

Request URL

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

allow_share_doc_to_work_profilebooleanOptional

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

allow_share_doc_to_personal_appsbooleanOptional

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

allow_profile_content_to_other_appsbooleanOptional

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

allow_profile_contact_over_bluetoothbooleanOptional

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

allow_profile_app_widgets_to_home_screenbooleanOptional

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

allow_contact_in_personal_profilebooleanOptional

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

allow_contact_access_to_personal_appsbooleanOptional

Whether personal apps can access work contacts. Default: false

allow_connected_appsintegerOptional

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

allowed_appsJSON ArrayOptional

List of apps allowed for cross-profile data sharing

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

allow_crossprofile_copy_pasteintegerOptional

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

allow_crossprofile_data_sharingintegerOptional

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

workprofile_turnoff_timeoutintegerOptional

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

enable_work_profile_system_appsarrayOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidworkdatasecuritypolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"allow_crossprofile_copy_paste":0,"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}'

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/androidworkdatasecuritypolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"allow_crossprofile_copy_paste\":0,\"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}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"allow_crossprofile_copy_paste\":0,\"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}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/androidworkdatasecuritypolicy/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("allow_share_doc_to_work_profile",true);
    data.put("allow_share_doc_to_personal_apps",true);
    data.put("allow_profile_content_to_other_apps",true);
    data.put("allow_profile_contact_over_bluetooth",true);
    data.put("allow_profile_app_widgets_to_home_screen",true);
    data.put("allow_contact_in_personal_profile",true);
    data.put("allow_contact_access_to_personal_apps",true);
    data.put("allow_connected_apps","1");
    data_allowed_apps=List();
    data_allowed_apps_item1=Map();
    data_allowed_apps_item1.put("group_display_name","value");
    data_allowed_apps_item1.put("app_id","1");
    data_allowed_apps.add(data_allowed_apps_item1);
    data.put("allowed_apps",data_allowed_apps);
    data.put("allow_crossprofile_copy_paste","1");
    data.put("allow_crossprofile_data_sharing","1");
    data.put("workprofile_turnoff_timeout","1");
    data_enable_work_profile_system_apps=List();
    data_enable_work_profile_system_apps.add("value");
    data.put("enable_work_profile_system_apps",data_enable_work_profile_system_apps);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidworkdatasecuritypolicy/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/androidworkdatasecuritypolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"allow_crossprofile_copy_paste":0,"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}'

Sample Request Body

Modify Work Data Security payload item

Copied!

  {
    "allow_crossprofile_copy_paste": 0,
    "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

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

Work Data Security payload item successfully modified

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