Cloud Administration Delete User Device API Cloud Administration Delete User Device API
You can use the Cloud Administration Delete User Device API to delete a user's device for the provided User ID and Device ID.
Note: Only one user device can be deleted per request.
AuthenticationAuthentication
Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.
Administrative RolesAdministrative Roles
This API can use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration REST API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to delete a particular user's device.
| Method | Request URL | Response Codes |
|---|---|---|
| DELETE | /AdminInterface/restapi/v1/users/<userId>/devices/<deviceId> | 200, 400, 403, 404, 500 |
Example Request DataExample Request Data
The following example displays a request to delete a device.
DELETE /AdminInterface/restapi/vi/users/<userid>/devices/<deviceId>
Accept: application/json
Authorization: Bearer <JWT token>
The delete device request does not contain any parameters.
Resource IdentifiersResource Identifiers
The following table shows the resource identifiers for a user and a device that are required in the request URL.
| Resource Identifier | Description |
|---|---|
| <userId> | A unique user identifier that is sent in the response to the SecurID User Details API. |
| <deviceId> | A unique device identifier that is sent in the response to the SecurID Device Details API. |
Note: Response examples and response property descriptions are not available for this API.
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
| Code | Description |
|---|---|
| 200 | User and device are successfully found. |
| 400 | User ID is not provided as parameter. |
| 403 | Not authorized to perform the request. |
| 404 | User and/or device is not found. |
| 500 | Internal error occurred when processing the request. |
| 429 | Too many requests. |
