Cloud Administration User Details API

The Cloud Administration User Details API enables Help Desk administrators to look up a single user without logging into the Cloud Administration Console. This API can look up only one user at a time.

Note:   Confirm that RSA has enabled SMS Tokencode and Voice Tokencode authentication for your company. Otherwise, the User Details API does not include the smsNumber and voiceNumber in the response.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For information on using this token, see Authentication for the Cloud Administration REST APIs.

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.

Example Request Data

The following example displays a request.

POST /AdminInterface/restapi/v1/users/lookup

Accept: application/json

Authorization: Bearer <JWT token>

Request Body Parameters

The following table describes the request parameters.

Example Request Body

{

"searchUnsynched" : "true",

"username" : "jschmoe",

“email” : “jschmoe@rsavia.com"

}

Example Response

The following example response shows the status of a single user on 31 May 2018:

{
    "id": "f85b6e95-f41f-45b4-bc84-559fead6460c",
    "emailAddress": "user.one@mycompany.com",
    "firstName": "User",
    "lastName": "One",
    "creationDate": "2018-08-31T19:10:30.045Z",
    "identitySource": "My Company AD",
    "userStatus": "Enabled",
    "markDeleted": false,
    "highRiskUser": false,
    "markDeletedAt": null,
    "markDeletedBy": null,
    "smsNumber": "+11235556799",
    "voiceNumber": "+1 774 291 4444",
    "isTokenLocked": false,
    "isSmsLocked": false,
    "isVoiceLocked": false,
    "lastSyncTime": "2018-08-31T19:20:30.045Z",
    "emergencyAccessStatus": "Disabled",
    "emergencyTokencodeId": null,
    "emergencyTokencodeExpiration": null,
    "emergencyTokencodeLastUse": null,
    "offlineEmergencyAccessStatus": "Disabled",
    "offlineEmergencyTokencodeExpiration": null,
    "monthLastAuthenticated": "Nov 2020",
    "identitySourceSpecificGroups": [
        "Group 1",
        "Group 2"
    ],
    "globalGroups": [
        "Group 3"
    ]
}

Response Property Descriptions

The following table shows property descriptions and data types.

Response Codes

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