User Risk

This feature is only available with Identity Threat Protection in Identity Engine.

The User Risk API enables you to manage a user's risk level within Okta.

Retrieve the user's risk
Identity Engine
OAuth 2.0: okta.userRisk.read

Retrieves the user risk object for a user ID

Request
path Parameters
userId
required
string

ID of an existing Okta user

Example: 00ub0oNGTSWTBKOLGLNR
Responses
200

OK

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/users/{userId}/risk
Request samples 
Response samples 
application/json
{}
Upsert the user's risk
Identity Engine
OAuth 2.0: okta.userRisk.manage
Upserts (creates or updates) the user risk object for a user ID


Request 
path Parameters
userId
required
string
ID of an existing Okta user


 
 Example:  00ub0oNGTSWTBKOLGLNR
Request Body schema: application/json
required
riskLevel
string
The risk level associated with the user


 Enum: "HIGH" "LOW"  
Responses 
200
Updated the user's risk


201
Created the user's risk


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/users/{userId}/risk
Request samples 
application/json
{
  • "riskLevel": "HIGH"
}
Response samples 
application/json
{}