Read One Risk Policy Set

GET {{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}

The GET {{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}} operation returns information about the risk policy set identified by its ID in the request URL.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  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))
}

GET /environments/{{envID}}/riskPolicySets/{{riskPolicySetID}} HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", 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_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
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 "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/riskPolicySets/{{riskPolicySetID}}")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

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/0408fde8-4269-41ef-a5a2-8fad7c8860eb"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "0408fde8-4269-41ef-a5a2-8fad7c8860eb",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "Example Policy",
    "description": "This is an example policy.",
    "createdAt": "2021-12-08T23:07:22.113Z",
    "updatedAt": "2021-12-08T23:07:22.113Z",
    "defaultResult": {
        "level": "LOW",
        "type": "VALUE"
    },
    "riskPolicies": [
        {
            "id": "7a4d9a80-aed6-4f12-9fd2-86fa56b7146d",
            "environment": {
                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
            },
            "policySet": {
                "id": "0408fde8-4269-41ef-a5a2-8fad7c8860eb"
            },
            "name": "GEOVELOCITY_ANOMALY",
            "priority": 1,
            "result": {
                "level": "HIGH",
                "type": "VALUE"
            },
            "condition": {
                "equals": true,
                "value": "${details.impossibleTravel}"
            },
            "createdAt": "2021-12-08T23:07:22.113Z",
            "updatedAt": "2021-12-08T23:07:22.113Z"
        },
        {
            "id": "d368a8f9-482e-4dbe-815b-0d5ab0d652ff",
            "environment": {
                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
            },
            "policySet": {
                "id": "0408fde8-4269-41ef-a5a2-8fad7c8860eb"
            },
            "name": "MEDIUM_WEIGHTED_POLICY",
            "priority": 2,
            "result": {
                "level": "MEDIUM",
                "type": "VALUE"
            },
            "condition": {
                "between": {
                    "minScore": 40,
                    "maxScore": 70
                },
                "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-12-08T23:07:22.113Z",
            "updatedAt": "2021-12-08T23:07:22.113Z"
        },
        {
            "id": "7ccfd5c9-bd07-4407-b9ca-b52a6d9fac41",
            "environment": {
                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
            },
            "policySet": {
                "id": "0408fde8-4269-41ef-a5a2-8fad7c8860eb"
            },
            "name": "HIGH_WEIGHTED_POLICY",
            "priority": 3,
            "result": {
                "level": "HIGH",
                "type": "VALUE"
            },
            "condition": {
                "between": {
                    "minScore": 70,
                    "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-12-08T23:07:22.113Z",
            "updatedAt": "2021-12-08T23:07:22.113Z"
        }
    ],
    "evaluatedPredictors": [
        {
            "id": "4a1ff613-0f6c-0fab-303f-9f4aba12d9bb"
        },
        {
            "id": "174afbf5-f7aa-0b8d-1dc5-53755bd70561"
        },
        {
            "id": "56d1eea9-68ca-0373-2b3b-6c67329e1448"
        },
        {
            "id": "0b5be633-d2ef-0776-06c7-a027ac6e47c2"
        },
        {
            "id": "1e4a9750-e6a8-4cb3-9f66-94ff6d4b857e"
        },
        {
            "id": "3ab65954-05b0-4ed4-b525-5830be4c6e18"
        }
    ],
    "default": false
}