Delete Device
Delete Device API will delete the user 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
DELETE https://{tenantId}.{hostname}/digitanium/v4/devices/{deviceid}
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_device/{deviceid}
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 - when device is locked, false - when device is already locked, null - when device does not exist. |
Sample Response
{
"subSystem": 6,
"status": "OK",
"message": "DeviceId deleted successfully.",
"data": true
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | DeviceId deleted successfully. |
400 | DEVICE_PARAMETER_INVALID | Error, either the device parameter 'deviceID' must have a positive value, or the 'issuerDN' and 'serial number' must not be null or empty. |
401 | Unauthorized | HTTP 401 Unauthorized. |
404 | DEVICEID_NOT_FOUND | DeviceId does not exist. |