RSA SecurID Access Device Details 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

The RSA SecurID Access Device Details API enables Help Desk administrators to look up user devices using a User ID.


Note:  The API  can retrieve all user devices for a single user per request.




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 retrieve information about a particular user's device.


MethodRequest URLResponse Content TypeResponse BodyResponse Codes
application/jsonUser device details with property200, 400, 403, 404, 500


Example Request Data


The following example displays a request.


GET /AdminInterface/restapi/v1/users/<userId>/devices


Accept: application/json


Authorization: Bearer <JWT token>


The Device Details request does not contain any parameters.


The resource identifier <userId> is a unique user identifier that is sent in the response to the RSA SecurID Access User Details API .


Example Response


The following example response shows the status of a single user's device.




"id": "3a48a1a5-444c-4c95-b3f0-b5aa8273a019",


"name": "'s%20FIDO%20token",


"userid": "e71d6d46-0113-495a-9445-b3f71b6e3f36",


"osType": "FIDO Token",


"capabilities": null,


"registeredDate": "2018-09-06T15:34:44.000Z",


"lastUsedDate": "2018-09-06T15:34:44.000Z"




Property Response Descriptions


The following table shows property response descriptions and data types.


PropertyDescriptionData Type
idIdentifies the device.String
nameDevice name.String
userIdIdentifies the user associated with this device.String
osTypeOperating system information related to the device, browser, or FIDO token.String


registeredDate (for FIDO token)

Timestamp when the device was registered.

for information on formatting timestamps in ISO 8601 format.

Timestamp when the FIDO token was registered. For FIDO tokens, the following fields are created:

lastUsedDateTimestamp when the device was last used. See
for information on formatting timestamps in ISO 8601 format.


Response Codes


The following table shows response codes and descriptions for the Device Details API.


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 Device Details API