Cloud Administration Retrieve High-Risk User List API

Document created by RSA Information Design and Development on Mar 22, 2019Last modified by RSA Information Design and Development on Jul 26, 2019
Version 5Show Document
  • View in full screen mode

Use the Cloud Administration Retrieve High-Risk User List API to retrieve users who have been marked as high risk. Accounts for these users may have been compromised. A security information and event management (SIEM) solution, such as RSA NetWitness, may mark users with suspicious activity as high risk.

Note:  This API is available only for Premium Edition.

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 must use an API key that is associated with the Super 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 RSA SecurID Access Administration REST API Download.

Request Requirements

Use the following information to retrieve a list of users who are marked as high risk.

                        
MethodRequest URLResponse Content TypeResponse BodyResponse Codes
GET /AdminInterface/restapi/v1/users/highriskapplication/jsonList of user emails that contains a high-risk flag set to true.200, 400, 403, 500

Request Body Parameters

No query parameters are supported at this time.

Example Request Body

The following example displays a request.

GET /AdminInterface/restapi/v1/users/highrisk

No Body

Authorization: Bearer <JWT token>

Example Response Body

The following example displays a response body.

{

"users": [

"user.three@mycompany.com",

"user.two@mycompany.com",

"user.one@mycompany.com"

]

}

Response Codes

The following table shows response codes for this API.

                           
CodeDescription
200Operation completed successfully.
400Operation not performed because of client syntax errors.
403Not authorized to perform the request.
500

Internal error occurred.

 

 

You are here
Table of Contents > Cloud Administration APIs > Cloud Administration Retrieve High-Risk User List API

Attachments

    Outcomes