Create Risk Predictor (Traffic anomaly)
POST {{apiPath}}/environments/{{envID}}/riskPredictors
This request creates a traffic anomaly predictor.
The rules array contains a single rule - tracking of unique users on a single device, the only rule that can currently be included in traffic anomaly predictors.
The threshold object is used to specify the number of users that will be considered Medium risk and the number of users that will be considered High risk.
The interval object is used to define the timeframe for tracking unique users on a device.
Prerequisites
- See PingOne Protect and Risk Predictors for important overview information.
See Risk Predictors for the complete data models.
Base data model
| Property | Type | Required? |
|---|---|---|
compactName | String | Required |
default | Object | Required |
default.result.level | String | Required |
default.result.type | String | Required |
name | String | Required |
rules | Array | Optional |
rules\[\].enabled | Boolean | Required |
rules\[\].interval | Object | Required |
rules\[\].interval.unit | String | Required |
rules\[\].interval.quantity | Integer | Required |
rules\[\].threshold | Object | Required |
rules\[\].threshold.medium | Integer | Required |
rules\[\].threshold.high | Integer | Required |
rules\[\].type | String | Required |
type | String | Required |
Request Body
{"name"=>"Traffic anomaly predictor created with API", "compactName"=>"trafficAnomalyCreatedFromAPI", "type"=>"TRAFFIC_ANOMALY", "default"=>{"result"=>{"level"=>"medium", "type"=>"VALUE"}}, "rules"=>[{"type"=>"UNIQUES_USERS_PER_DEVICE", "threshold"=>{"medium"=>3, "high"=>6}, "interval"=>{"unit"=>"DAY", "quantity"=>7}, "enabled"=>true}]}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/riskPredictors/fe36c631-6520-431b-a586-e680277a9f85"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"fe36c631-6520-431b-a586-e680277a9f85","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"createdAt":"2024-08-06T15:22:09.536Z","createdBy":"USER_DEFINED","updatedAt":"2024-08-06T15:22:09.536Z","name":"Traffic anomaly predictor created with API","compactName":"trafficAnomalyCreatedFromAPI","licensed":true,"rules":[{"type":"UNIQUES_USERS_PER_DEVICE","threshold":{"medium":3,"high":6},"interval":{"unit":"DAY","quantity":7},"enabled":true}],"type":"TRAFFIC_ANOMALY","condition":{"scores":[{"name":"HIGH","value":"HIGH"},{"name":"MEDIUM","value":"MEDIUM"},{"name":"LOW","value":"LOW"}]},"deletable":true,"tooltip":"predictor.tooltip.traffic.anomaly","default":{"weight":5,"score":80,"result":{"level":"MEDIUM","type":"VALUE"},"evaluated":false}}