Page Comparison

Excerpt

Description Add a screen lock on Android devices.

Resource Path /lock

URL /mdm-android-agent/operation/lock

HTTP Method POST

Request/Response Format application/json

cURL command

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-android-agent/operation/lock

For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
Define the path to the JSON file, which lists the devices that this operation is applied on, as the <JSON_PAYLOAD> value.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer f409r4c55924rt4af9a44tts15y9d6cd56h1047d" -d @'test.json' -k -v https://localhost:9443/mdm-android-agent/operation/lock

Sample output

Code Block

> POST /mdm-android-agent/operation/lock HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer f409r4c55924rt4af9a44tts15y9d6cd56h1047d
> Content-Length: 21
< HTTP/1.1 201 Created
< Date: Fri, 18 Mar 2016 08:18:20 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server

Anchor

	sample
	sample

Sample JSON Definition

Code Block
{ "operation": { "message": "This is a test message", "isHardLockEnabled": true }, "deviceIDs": [ "d8:50:e6:2f:6a:8b", "a5:60:e6:2g:6a:5b" ] }

Property Value

Description

Data
Type

operation Lists out the features of the device lock operation. -

message Provide the message that needs to be sent otu when locking the device. String

isHardLockEnableddevice

idDefine true as the value if you need to hard device lock or define false as the value to only screen lock the device.

Info
Using hard lock, the admin is able to lock the device permanently. If the device is locked permanently, the admin can unlock the device via the device unlock REST API.

Boolean

deviceIDs

ID of the Android device. Multiple device IDs can be added by using comma separated values.
For more information on retrieving the device ID, see Retrieving the ID of an Android device.

String

Versions Compared

Old Version 5

New Version 6

Key