Modify the configuration of a App Lock payload item within a profile

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 modify App Lock policy payload item

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
idle_refresh_timeoutintegerOptional

Idle refresh timeout for web app kiosk in seconds. -1 means disabled. Default: -1

clear_session_and_cookiesbooleanOptional

Clear Session And Cookies. Default: true

webclippoliciesJSON ArrayOptional

List of web clips configured for kiosk mode

Show Sub-Attributes
JSON Object
Show Sub-Attributes
webclip_policy_idlongOptional

Web clip policy ID

webclip_namestringOptional

Display name of the web clip

auto_distribute_webappbooleanOptional

Auto Distribute Webapp. Default: true

app_namestringOptional

App Name

identifierstringOptional

Identifier

disable_touchbooleanOptional

Disable Touch. Default: false

disable_device_rotationbooleanOptional

Disable Device Rotation. Default: false

disable_volume_buttonsbooleanOptional

Disable Volume Buttons. Default: false

disable_ringer_switchbooleanOptional

Disable Ringer Switch. Default: false

disable_sleep_buttonbooleanOptional

Disable Sleep Button. Default: false

disable_auto_lockbooleanOptional

Disable Auto Lock. Default: true

voice_overbooleanOptional

Voice Over. Default: false

zoombooleanOptional

Zoom. Default: false

invert_colorsbooleanOptional

Invert Colors. Default: false

asst_touchbooleanOptional

Asst Touch. Default: false

enable_speak_selectionbooleanOptional

Enable Speak Selection. Default: false

enable_mono_audiobooleanOptional

Enable Mono Audio. Default: false

enable_voice_controlbooleanOptional

Enable Voice Control. Default: false

show_me_mdm_appbooleanOptional

Show Me Mdm App. Default: true

kiosk_modeintegerMandatory

Kiosk mode type. Allowed values: 1=Single App Kiosk, 2=Multi App Kiosk, 3=Single Web App Kiosk

allowed_appsJSON ArrayOptional

List of allowed kiosk apps

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_idlongOptional

App ID of the kiosk app. Use the app_group_id from the Apps API response

group_display_namestringOptional

Display name of the app group

autonomous_kiosk_appsJSON ArrayOptional

List of autonomous single app mode apps

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_idlongOptional

App ID of the kiosk app. Use the app_group_id from the Apps API response

group_display_namestringOptional

Display name of the app group

auto_distribute_appsbooleanOptional

Auto Distribute Apps. Default: false

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/applockpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"app_name":"Zylker User","identifier":"value","disable_volume_buttons":false,"disable_ringer_switch":false,"idle_refresh_timeout":-1,"webclippolicies":[{"webclip_policy_id":9007199254741076,"webclip_name":"Zylker Web Clip"}],"clear_session_and_cookies":true,"disable_touch":false,"disable_device_rotation":false,"kiosk_mode":1,"auto_distribute_webapp":true}'

Sample Request Body

Modify App Lock payload item

Copied!
  {
    "app_name": "Zylker User",
    "identifier": "value",
    "disable_volume_buttons": false,
    "disable_ringer_switch": false,
    "idle_refresh_timeout": -1,
    "webclippolicies": [
      {
        "webclip_policy_id": 9007199254741076,
        "webclip_name": "Zylker Web Clip"
      }
    ],
    "clear_session_and_cookies": true,
    "disable_touch": false,
    "disable_device_rotation": false,
    "kiosk_mode": 1,
    "auto_distribute_webapp": true
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

idle_refresh_timeoutinteger

Idle refresh timeout for web app kiosk in seconds. -1 means disabled. Default: -1

clear_session_and_cookiesboolean

Clear Session And Cookies. Default: true

webclippoliciesJSON Array

List of web clips configured for kiosk mode

Show Sub-Attributes
JSON Object
Show Sub-Attributes
webclip_policy_idlong

Web clip policy ID

webclip_namestring

Display name of the web clip

auto_distribute_webappboolean

Auto Distribute Webapp. Default: true

app_namestring

App Name

identifierstring

Identifier

disable_touchboolean

Disable Touch. Default: false

disable_device_rotationboolean

Disable Device Rotation. Default: false

disable_volume_buttonsboolean

Disable Volume Buttons. Default: false

disable_ringer_switchboolean

Disable Ringer Switch. Default: false

disable_sleep_buttonboolean

Disable Sleep Button. Default: false

disable_auto_lockboolean

Disable Auto Lock. Default: true

voice_overboolean

Voice Over. Default: false

zoomboolean

Zoom. Default: false

invert_colorsboolean

Invert Colors. Default: false

asst_touchboolean

Asst Touch. Default: false

enable_speak_selectionboolean

Enable Speak Selection. Default: false

enable_mono_audioboolean

Enable Mono Audio. Default: false

enable_voice_controlboolean

Enable Voice Control. Default: false

show_me_mdm_appboolean

Show Me Mdm App. Default: true

kiosk_modeinteger

Kiosk mode type. Allowed values: 1=Single App Kiosk, 2=Multi App Kiosk, 3=Single Web App Kiosk

allowed_appsJSON Array

List of allowed kiosk apps

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_idlong

App ID of the kiosk app. Use the app_group_id from the Apps API response

group_display_namestring

Display name of the app group

autonomous_kiosk_appsJSON Array

List of autonomous single app mode apps

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_idlong

App ID of the kiosk app. Use the app_group_id from the Apps API response

group_display_namestring

Display name of the app group

auto_distribute_appsboolean

Auto Distribute Apps. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

App Lock payload item successfully modified

Copied!
  {
    "app_name": "Zylker User",
    "identifier": "value",
    "payload_id": 9007199254741000,
    "disable_volume_buttons": false,
    "disable_ringer_switch": false,
    "idle_refresh_timeout": -1,
    "webclippolicies": [
      {
        "webclip_policy_id": 9007199254741076,
        "webclip_name": "Zylker Web Clip"
      }
    ],
    "clear_session_and_cookies": true,
    "disable_touch": false,
    "disable_device_rotation": false,
    "kiosk_mode": 1,
    "auto_distribute_webapp": true
  }
                
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.