Logout Device

Logout Device API will logout the user device based on the provided DeviceID.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

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

HTTP request URL for SHIFT

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

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.

Parameters

No parameter fields are required.

Request body

No request body fields are required.

Response

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 - device logged off sucessfully, null - device does not exist

Sample Response

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

Response Status Information

Status Code	Status	Message
200	OK	Device logged out successfully
400	BAD_REQUEST	DeviceID should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized
404	DEVICE_NOT_FOUND	Device does not exist