Lock Device

Lock Device API will lock the user device based on the provided DeviceID.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Key	Value
Authorization	Bearer token
Content-Type	application/json

POST https://{tenantId}.{hostname}/digitanium/v4/devices/{deviceid}/lock

POST https://{hostname}/auth/realms/{tenantId}/v3_device/{deviceid}/lock

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

No parameter fields are required.

No request body fields are required.

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Boolean	true - when device is locked, false - when device is already locked, null - when device does not exist.

{
	"subSystem": 6,
	"status": "OK",
	"message": "Device locked successfully.",
	"data": true
}

Status Code	Status	Message
200	OK	Device locked successfully
400	BAD_REQUEST	DeviceID should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized
404	DEVICE_NOT_FOUND	Device does not exist
409	CONFLICT	Device already locked