PingOne Platform APIs

Protect Settings

Use the riskSettings endpoint to specify maximum data retention periods for the risk data that is used by specific predictors.

You can define different data retention periods for each of the following risk predictors:

  • New Device

  • User Location Anomaly

  • User Base Risk Behavior

When you modify the maximum data retention period, the new period applies only to the new data that is collected after you changed the setting.

Protect settings data model

Property Type Required? Mutable? Description

dataRetention

Object

Required

Mutable

The object that contains the fields for setting the data retention period for specific risk predictors.

dataRetention.newDeviceInDays

Integer

Optional

Mutable

The number of days that data for the New Device predictor should be retained. Minimum is 1, maximum is 180. Default is 180.

dataRetention.userBasedRiskBehaviorInDays

Integer

Optional

Mutable

The number of days that data for the User Based Risk Behavior predictor should be retained. Minimum is 30, maximum is 180. Default is 180.

dataRetention.userLocationAnomalyInDays

Integer

Optional

Mutable

The number of days that data for the User Location Anomaly predictor should be retained. Minimum is 30, maximum is 90. Default is 90.

environment.id

String

N/A

Read-only

The ID of the PingOne environment for which the Protect settings are being modified.

updatedAt

Date

N/A

Read-only

The date and time the Protect settings were last updated.