Cloud Administration Authenticator Details API

Document created by RSA Information Design and Development on Oct 19, 2018Last modified by RSA Information Design and Development on Mar 9, 2020
Version 18Show Document
  • View in full screen mode

The Cloud Administration Device Details API enables Help Desk administrators to look up user authenticators using a User ID.

Note:  The API  can retrieve all user authenticators for a single user 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 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 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 authenticator.

                        
MethodRequest URLResponse Content TypeResponse BodyResponse Codes
GET /AdminInterface/restapi/v1/users/
<userId>/devices
application/jsonUser authenticator details with property200, 400, 403, 404, 500

Resource Identifier

The resource identifier is optional.

                  
Resource IDDescriptionType
<includeBrowsers>Set to True to include the browser authenticator type, or False to exclude the browser authenticator type. When you omit this identifier, the browser authenticator type is included.Boolean

Example Request Data

The following example displays a request to retrieve all authenticator types other than browser authenticator type.

GET /AdminInterface/restapi/v1/users/<userId>/devices?includeBrowsers=false

Accept: application/json

Authorization: Bearer <JWT token>

The request does not contain any parameters.

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

Example Response

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

{

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

"name": "john.doe%40rsa.com'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 authenticator.String
nameAuthenticator name.String
userIdIdentifies the user associated with this authenticator.String
osTypeOperating system information related to the authenticator or browser.String

registeredDate

registeredDate (for FIDO authenticator)

Timestamp when the authenticator was registered.

See https://www.w3.org/TR/NOTE-datetime
for information on formatting timestamps in ISO 8601 format.

Timestamp when the FIDO authenticator was registered. For FIDO authenticators, the following fields are created:
_at
registration_time

String
lastUsedDateTimestamp when the authenticator was last used. See https://www.w3.org/TR/NOTE-datetime
for information on formatting timestamps in ISO 8601 format.
String

Response Codes

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

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

 

 

We want your feedback! Tell us what you think of this page.

You are here
Table of Contents > Cloud Administration APIs > Cloud Administration Authenticator Details API

Attachments

    Outcomes