RSA SecurID Access Delete User Device API

Document created by RSA Information Design and Development on Oct 19, 2018Last modified by Joyce Cohen on Mar 4, 2019
Version 5Show Document
  • View in full screen mode

You can use the RSA SecurID Access 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.

 

Authentication

 

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 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 Kit

 

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

 

Request Requirements

 

Use the following information to delete a particular user's device.

 

MethodRequest URLResponse Codes
DELETE/AdminInterface/restapi/v1/users/<userId>/devices/<deviceId>200, 400, 403, 404, 500

 

Example 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 Identifiers

 

The following table shows the resource identifiers for a user and a device that are required in the request URL.

 

Resource IdentifierDescription
<userId>A unique user identifier that is sent in the response to the RSA SecurID Access User Details API .
<deviceId>A unique device identifier that is sent in the response to the RSA SecurID Access Device Details API .

 

Note:  Response examples and property response descriptions are not available for this API.

 

Response Codes

 

The following table shows response codes and descriptions for this API.

 

CodeDescription
200User and device are successfully found.
400User ID is not provided as parameter.
403Not authorized to perform the request.
404User and/or device is not found.
500Internal error occurred when processing the request.

 

 

 

 

 

 

 

You are here

Table of Contents > Cloud Administration REST APIs > RSA SecurID Access Delete User Device API

Attachments

    Outcomes