Cloud Administration Retrieve High-Risk User List API Version 2

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 NetWitness, may mark users with suspicious activity as high risk. For more information, see Determining Access Requirements for High-Risk Users in Cloud Access Service.

For Version 1 of this API, see Cloud Administration Retrieve High-Risk User List API.

Note:  This API is licensed. See ID Plus Subscription Plans.

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 instructions 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 a list of users who are marked as high risk.

Request Body Parameters

No query parameters are supported at this time.

Example Request Body

The following example displays a request.

GET /AdminInterface/restapi/v2/users/highrisk

No Body

Authorization: Bearer <JWT token>

Example Response Body

The following example displays a response body.

{

"users": [

{

"email": "user.one@mycompany.com",

"primaryUsername": "user.one",

"alternateUsername":""

},

{

"email": "user.two@mycompany.com",

"primaryUsername": "user.two",

"alternateUsername":""

},

{

"email": "user.three@mycompany.com",

"primaryUsername": "user.three",

"alternateUsername":""

},

]

}

Response Property Descriptions

The following table shows response property descriptions and data types.

Response Codes

The following table shows response codes for this API.