Update Risk Policy Set
PUT {{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}
The UPDATE /environments/{{envID}}/riskPolicySets/{{riskPolicySetID}} operation updates the risk policy set identified by its ID in the request URL.
You can use this request to add the triggers object to a policy set to enable staging of another policy set.
Prerequisites
-
Refer to Risk Policies for important overview information.
Request Model
Refer to Risk Predictors for more information, including the data models.
Base data model
| Property | Type | Required? |
|---|---|---|
|
Date |
Required |
|
Boolean |
Optional |
|
Object |
Optional |
|
String |
Optional |
|
String |
Required |
|
String[] |
Optional |
|
String |
Required |
|
String |
Required |
|
String[] |
Required |
|
Object[] |
Optional |
|
String |
Required |
|
Object |
Required |
|
String |
Required |
|
String |
Required |
|
Date |
Required |
Risk policies data model
This table lists the fields and objects that can be included in each of the elements in the riskPolicies array.
| Property | Type | Required? |
|---|---|---|
|
Object |
Required |
|
Array |
Required/Optional |
|
String |
Required |
|
Integer |
Required |
|
String |
Required |
|
Integer |
Required/Optional |
|
Integer |
Required/Optional |
|
Date |
Required |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
Integer |
Required |
|
String |
Required |
|
Date |
Required |
Body
raw ( application/json )
{
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""name"": ""Example Policy""," + "\n" +
@" ""description"": ""This is an example policy.""," + "\n" +
@" ""defaultResult"": {" + "\n" +
@" ""level"": ""Low""" + "\n" +
@" }," + "\n" +
@" ""riskPolicies"": [" + "\n" +
@" {" + "\n" +
@" ""name"": ""GEOVELOCITY_ANOMALY""," + "\n" +
@" ""result"": {" + "\n" +
@" ""level"": ""HIGH""" + "\n" +
@" }," + "\n" +
@" ""condition"": {" + "\n" +
@" ""value"": ""${details.impossibleTravel}""," + "\n" +
@" ""equals"": true" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""name"": ""MEDIUM_WEIGHTED_POLICY""," + "\n" +
@" ""result"": {" + "\n" +
@" ""level"": ""MEDIUM""" + "\n" +
@" }," + "\n" +
@" ""condition"": {" + "\n" +
@" ""aggregatedWeights"": [" + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.anonymousNetwork}""," + "\n" +
@" ""weight"": 8" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.geoVelocity}""," + "\n" +
@" ""weight"": 4" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.ipRisk}""," + "\n" +
@" ""weight"": 8" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.ipVelocityByUser}""," + "\n" +
@" ""weight"": 5" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userRiskBehavior}""," + "\n" +
@" ""weight"": 10" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userBasedRiskBehavior}""," + "\n" +
@" ""weight"": 10" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userVelocityByIp}""," + "\n" +
@" ""weight"": 5" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""between"": {" + "\n" +
@" ""minScore"": 40," + "\n" +
@" ""maxScore"": 80" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""name"": ""HIGH_WEIGHTED_POLICY""," + "\n" +
@" ""result"": {" + "\n" +
@" ""level"": ""HIGH""" + "\n" +
@" }," + "\n" +
@" ""condition"": {" + "\n" +
@" ""aggregatedWeights"": [" + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.anonymousNetwork}""," + "\n" +
@" ""weight"": 8" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.geoVelocity}""," + "\n" +
@" ""weight"": 4" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.ipRisk}""," + "\n" +
@" ""weight"": 8" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.ipVelocityByUser}""," + "\n" +
@" ""weight"": 5" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userRiskBehavior}""," + "\n" +
@" ""weight"": 10" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userBasedRiskBehavior}""," + "\n" +
@" ""weight"": 10" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${details.aggregatedWeights.userVelocityByIp}""," + "\n" +
@" ""weight"": 5" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""between"": {" + "\n" +
@" ""minScore"": 80," + "\n" +
@" ""maxScore"": 100" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}"
method := "PUT"
payload := strings.NewReader(`{
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
PUT /environments/{{envID}}/riskPolicySets/{{riskPolicySetID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"Example Policy\",\n \"description\": \"This is an example policy.\",\n \"defaultResult\": {\n \"level\": \"Low\"\n },\n \"riskPolicies\": [\n {\n \"name\": \"GEOVELOCITY_ANOMALY\",\n \"result\": {\n \"level\": \"HIGH\"\n },\n \"condition\": {\n \"value\": \"${details.impossibleTravel}\",\n \"equals\": true\n }\n },\n {\n \"name\": \"MEDIUM_WEIGHTED_POLICY\",\n \"result\": {\n \"level\": \"MEDIUM\"\n },\n \"condition\": {\n \"aggregatedWeights\": [\n {\n \"value\": \"${details.aggregatedWeights.anonymousNetwork}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.geoVelocity}\",\n \"weight\": 4\n },\n {\n \"value\": \"${details.aggregatedWeights.ipRisk}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.ipVelocityByUser}\",\n \"weight\": 5\n },\n {\n \"value\": \"${details.aggregatedWeights.userRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userBasedRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userVelocityByIp}\",\n \"weight\": 5\n }\n ],\n \"between\": {\n \"minScore\": 40,\n \"maxScore\": 80\n }\n }\n },\n {\n \"name\": \"HIGH_WEIGHTED_POLICY\",\n \"result\": {\n \"level\": \"HIGH\"\n },\n \"condition\": {\n \"aggregatedWeights\": [\n {\n \"value\": \"${details.aggregatedWeights.anonymousNetwork}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.geoVelocity}\",\n \"weight\": 4\n },\n {\n \"value\": \"${details.aggregatedWeights.ipRisk}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.ipVelocityByUser}\",\n \"weight\": 5\n },\n {\n \"value\": \"${details.aggregatedWeights.userRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userBasedRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userVelocityByIp}\",\n \"weight\": 5\n }\n ],\n \"between\": {\n \"minScore\": 80,\n \"maxScore\": 100\n }\n }\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}"
payload = json.dumps({
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "${details.impossibleTravel}",
"equals": True
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "name": "Example Policy",\n "description": "This is an example policy.",\n "defaultResult": {\n "level": "Low"\n },\n "riskPolicies": [\n {\n "name": "GEOVELOCITY_ANOMALY",\n "result": {\n "level": "HIGH"\n },\n "condition": {\n "value": "${details.impossibleTravel}",\n "equals": true\n }\n },\n {\n "name": "MEDIUM_WEIGHTED_POLICY",\n "result": {\n "level": "MEDIUM"\n },\n "condition": {\n "aggregatedWeights": [\n {\n "value": "${details.aggregatedWeights.anonymousNetwork}",\n "weight": 8\n },\n {\n "value": "${details.aggregatedWeights.geoVelocity}",\n "weight": 4\n },\n {\n "value": "${details.aggregatedWeights.ipRisk}",\n "weight": 8\n },\n {\n "value": "${details.aggregatedWeights.ipVelocityByUser}",\n "weight": 5\n },\n {\n "value": "${details.aggregatedWeights.userRiskBehavior}",\n "weight": 10\n },\n {\n "value": "${details.aggregatedWeights.userBasedRiskBehavior}",\n "weight": 10\n },\n {\n "value": "${details.aggregatedWeights.userVelocityByIp}",\n "weight": 5\n }\n ],\n "between": {\n "minScore": 40,\n "maxScore": 80\n }\n }\n },\n {\n "name": "HIGH_WEIGHTED_POLICY",\n "result": {\n "level": "HIGH"\n },\n "condition": {\n "aggregatedWeights": [\n {\n "value": "${details.aggregatedWeights.anonymousNetwork}",\n "weight": 8\n },\n {\n "value": "${details.aggregatedWeights.geoVelocity}",\n "weight": 4\n },\n {\n "value": "${details.aggregatedWeights.ipRisk}",\n "weight": 8\n },\n {\n "value": "${details.aggregatedWeights.ipVelocityByUser}",\n "weight": 5\n },\n {\n "value": "${details.aggregatedWeights.userRiskBehavior}",\n "weight": 10\n },\n {\n "value": "${details.aggregatedWeights.userBasedRiskBehavior}",\n "weight": 10\n },\n {\n "value": "${details.aggregatedWeights.userVelocityByIp}",\n "weight": 5\n }\n ],\n "between": {\n "minScore": 80,\n "maxScore": 100\n }\n }\n }\n ]\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"name": "Example Policy",
"description": "This is an example policy.",
"defaultResult": {
"level": "Low"
},
"riskPolicies": [
{
"name": "GEOVELOCITY_ANOMALY",
"result": {
"level": "HIGH"
},
"condition": {
"value": "\${details.impossibleTravel}",
"equals": true
}
},
{
"name": "MEDIUM_WEIGHTED_POLICY",
"result": {
"level": "MEDIUM"
},
"condition": {
"aggregatedWeights": [
{
"value": "\${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "\${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "\${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "\${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "\${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "\${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "\${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 40,
"maxScore": 80
}
}
},
{
"name": "HIGH_WEIGHTED_POLICY",
"result": {
"level": "HIGH"
},
"condition": {
"aggregatedWeights": [
{
"value": "\${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "\${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "\${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "\${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "\${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "\${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "\${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
],
"between": {
"minScore": 80,
"maxScore": 100
}
}
}
]
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"name\": \"Example Policy\",\n \"description\": \"This is an example policy.\",\n \"defaultResult\": {\n \"level\": \"Low\"\n },\n \"riskPolicies\": [\n {\n \"name\": \"GEOVELOCITY_ANOMALY\",\n \"result\": {\n \"level\": \"HIGH\"\n },\n \"condition\": {\n \"value\": \"${details.impossibleTravel}\",\n \"equals\": true\n }\n },\n {\n \"name\": \"MEDIUM_WEIGHTED_POLICY\",\n \"result\": {\n \"level\": \"MEDIUM\"\n },\n \"condition\": {\n \"aggregatedWeights\": [\n {\n \"value\": \"${details.aggregatedWeights.anonymousNetwork}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.geoVelocity}\",\n \"weight\": 4\n },\n {\n \"value\": \"${details.aggregatedWeights.ipRisk}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.ipVelocityByUser}\",\n \"weight\": 5\n },\n {\n \"value\": \"${details.aggregatedWeights.userRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userBasedRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userVelocityByIp}\",\n \"weight\": 5\n }\n ],\n \"between\": {\n \"minScore\": 40,\n \"maxScore\": 80\n }\n }\n },\n {\n \"name\": \"HIGH_WEIGHTED_POLICY\",\n \"result\": {\n \"level\": \"HIGH\"\n },\n \"condition\": {\n \"aggregatedWeights\": [\n {\n \"value\": \"${details.aggregatedWeights.anonymousNetwork}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.geoVelocity}\",\n \"weight\": 4\n },\n {\n \"value\": \"${details.aggregatedWeights.ipRisk}\",\n \"weight\": 8\n },\n {\n \"value\": \"${details.aggregatedWeights.ipVelocityByUser}\",\n \"weight\": 5\n },\n {\n \"value\": \"${details.aggregatedWeights.userRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userBasedRiskBehavior}\",\n \"weight\": 10\n },\n {\n \"value\": \"${details.aggregatedWeights.userVelocityByIp}\",\n \"weight\": 5\n }\n ],\n \"between\": {\n \"minScore\": 80,\n \"maxScore\": 100\n }\n }\n }\n ]\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "PUT"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/riskPolicySets/c6047190-1fac-4b8b-82d6-b237316ede5d"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}
},
"id": "c6047190-1fac-4b8b-82d6-b237316ede5d",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"name": "Example Policy",
"description": "This is an example policy.",
"createdAt": "2021-04-07T11:43:38.486Z",
"updatedAt": "2021-04-07T11:57:40.560Z",
"defaultResult": {
"level": "LOW",
"type": "VALUE"
},
"riskPolicies": [
{
"id": "6e90c60d-5d4c-4b95-9d14-8b6ba2ad6245",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "c6047190-1fac-4b8b-82d6-b237316ede5d"
},
"name": "GEOVELOCITY_ANOMALY",
"priority": 1,
"result": {
"level": "HIGH",
"type": "VALUE"
},
"condition": {
"equals": true,
"value": "${details.impossibleTravel}"
},
"createdAt": "2021-04-07T11:57:40.560Z",
"updatedAt": "2021-04-07T11:57:40.560Z"
},
{
"id": "40883824-efcf-4b0a-a9af-eaec2f6e1f3e",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "c6047190-1fac-4b8b-82d6-b237316ede5d"
},
"name": "MEDIUM_WEIGHTED_POLICY",
"priority": 2,
"result": {
"level": "MEDIUM",
"type": "VALUE"
},
"condition": {
"between": {
"minScore": 40,
"maxScore": 80
},
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
]
},
"createdAt": "2021-04-07T11:57:40.560Z",
"updatedAt": "2021-04-07T11:57:40.560Z"
},
{
"id": "f72e32a2-cde0-4b32-808a-d0768e30c4e0",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "c6047190-1fac-4b8b-82d6-b237316ede5d"
},
"name": "HIGH_WEIGHTED_POLICY",
"priority": 3,
"result": {
"level": "HIGH",
"type": "VALUE"
},
"condition": {
"between": {
"minScore": 80,
"maxScore": 100
},
"aggregatedWeights": [
{
"value": "${details.aggregatedWeights.anonymousNetwork}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.geoVelocity}",
"weight": 4
},
{
"value": "${details.aggregatedWeights.ipRisk}",
"weight": 8
},
{
"value": "${details.aggregatedWeights.ipVelocityByUser}",
"weight": 5
},
{
"value": "${details.aggregatedWeights.userRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userBasedRiskBehavior}",
"weight": 10
},
{
"value": "${details.aggregatedWeights.userVelocityByIp}",
"weight": 5
}
]
},
"createdAt": "2021-04-07T11:57:40.560Z",
"updatedAt": "2021-04-07T11:57:40.560Z"
}
],
"default": false
}
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/riskPolicySets/fa0447ad-dac5-435a-be3b-b2c14f520167"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}
},
"id": "fa0447ad-dac5-435a-be3b-b2c14f520167",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"name": "Score-based policy",
"createdAt": "2022-09-22T14:10:59.266Z",
"updatedAt": "2022-09-22T14:33:15.032Z",
"defaultResult": {
"level": "LOW",
"type": "VALUE"
},
"riskPolicies": [
{
"id": "25e7162a-0941-486f-b308-ab6067b6170b",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "fa0447ad-dac5-435a-be3b-b2c14f520167"
},
"name": "ANONYMOUS_NETWORK_DETECTION",
"priority": 1,
"result": {
"level": "HIGH",
"type": "VALUE"
},
"condition": {
"equals": true,
"value": "${details.anonymousNetworkDetected}",
"type": "VALUE_COMPARISON"
},
"createdAt": "2022-09-22T14:33:15.032Z",
"updatedAt": "2022-09-22T14:33:15.032Z"
},
{
"id": "e094e610-2e47-4a1c-866c-3ac59f7f7890",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "fa0447ad-dac5-435a-be3b-b2c14f520167"
},
"name": "GEOVELOCITY_ANOMALY",
"priority": 2,
"result": {
"level": "MEDIUM",
"type": "VALUE"
},
"condition": {
"equals": true,
"value": "${details.impossibleTravel}",
"type": "VALUE_COMPARISON"
},
"createdAt": "2022-09-22T14:33:15.032Z",
"updatedAt": "2022-09-22T14:33:15.032Z"
},
{
"id": "15e49eb3-4932-4e05-84d0-cb97b9530542",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "fa0447ad-dac5-435a-be3b-b2c14f520167"
},
"name": "Medium scored policy",
"priority": 4,
"result": {
"level": "MEDIUM",
"type": "VALUE"
},
"condition": {
"between": {
"minScore": 700,
"maxScore": 900
},
"aggregatedScores": [
{
"value": "${details.userLocationAnomaly.level}",
"score": 40
},
{
"value": "${details.anonymousNetwork.level}",
"score": 60
},
{
"value": "${details.ipRisk.level}",
"score": 40
}
],
"type": "AGGREGATED_SCORES"
},
"createdAt": "2022-09-22T14:33:15.032Z",
"updatedAt": "2022-09-22T14:33:15.032Z"
},
{
"id": "64f61fab-a24d-4919-bb89-d24cfc1ce678",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"policySet": {
"id": "fa0447ad-dac5-435a-be3b-b2c14f520167"
},
"name": "High scored policy",
"priority": 3,
"result": {
"level": "HIGH",
"type": "VALUE"
},
"condition": {
"between": {
"minScore": 900,
"maxScore": 1000
},
"aggregatedScores": [
{
"value": "${details.userLocationAnomaly.level}",
"score": 40
},
{
"value": "${details.anonymousNetwork.level}",
"score": 60
},
{
"value": "${details.ipRisk.level}",
"score": 40
}
],
"type": "AGGREGATED_SCORES"
},
"createdAt": "2022-09-22T14:33:15.032Z",
"updatedAt": "2022-09-22T14:33:15.032Z"
}
],
"triggers": [
{
"type": "POLICY_SET_STAGING",
"policySet": {
"id": "c468daa5-6d2a-40e2-9c63-1838aed36327"
},
"expiresAt": "2022-12-21T14:33:15.032Z"
}
],
"default": false
}