In this article
Unlink User from Device
Use this endpoint to unline a user from a device.
URL
https://{{HOST}}/security/device/user?v={version}deviceId={deviceId}&userId={userId}
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/user?deviceId=testDevice | string |
| userId required |
The ID of the user. | /device/user?userId=testUser | string |
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authorization required |
Bearer {access_token} | IMS access token |
Example
Request
curl -X DELETE
'https://{{HOST}/securityapi/device/user?v=2.0&deviceId=testDevice&userId=testUser'
-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 |