In this article
Delete Device
You can only delete a device that you are linked to.
Only Admin can delete a device without linking it first.
URL
https://{{HOST}}/security/device?v={version}&deviceId={DEVICEID}
Method
DELETE
Required IMS Scopes
- securityapi_all
Versions Supported
- 2.0 (Default)
URL Query Parameters
| Name | Description | Example | Type |
|---|---|---|---|
| v optional |
Version of the api to use | /device?v=2.0 | number |
| deviceId required |
The ID of the device. | /device?deviceId=testDevice | string |
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authorization required |
Bearer {access_token} | IMS access token |
Example
Request
curl -X DELETE
'https://{{HOST}}/securityapi/device?v=2.0&deviceId=testDevice'
-H 'Authorization: Bearer {access_token}'
Response
{
"success":"true"
}
Errors
| Error | Description |
|---|---|
| Error Name | Description of Error |
Response Body Parameters
| Name | Description | Schema |
|---|---|---|
| Object Name | Description | object definition |
| success | Description | object definition |