PingOne Platform APIs

Step 2: Create a risk evaluation

 

POST {{apiPath}}/environments/{{envID}}/riskEvaluations

The POST {{apiPath}}/environments/{{envID}}/riskEvaluations operation creates a new risk evaluation resource associated with the environment specified in the request URL. The request body defines the event that is processed for risk evaluation.

The request body specifies the riskPolicySet.id property value created in the USE CASE: Create a risk policy set use case. Note that if a risk policy set ID is not specified, the operation uses the environment’s default risk policy set.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
        "ip": "156.35.85.124",
        "user": {
            "id": "{{userID}}",
            "type": "EXTERNAL"
        }
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/riskEvaluations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
        "ip": "156.35.85.124",
        "user": {
            "id": "{{userID}}",
            "type": "EXTERNAL"
        }
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/riskEvaluations")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""riskPolicySet.id"": ""{{riskPolicySetID}}""," + "\n" +
@"    ""event"": {" + "\n" +
@"        ""ip"": ""156.35.85.124""," + "\n" +
@"        ""user"": {" + "\n" +
@"            ""id"": ""{{userID}}""," + "\n" +
@"            ""type"": ""EXTERNAL""" + "\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}}/riskEvaluations"
  method := "POST"

  payload := strings.NewReader(`{
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
        "ip": "156.35.85.124",
        "user": {
            "id": "{{userID}}",
            "type": "EXTERNAL"
        }
    }
}`)

  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))
}
POST /environments/{{envID}}/riskEvaluations HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
        "ip": "156.35.85.124",
        "user": {
            "id": "{{userID}}",
            "type": "EXTERNAL"
        }
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"riskPolicySet.id\": \"{{riskPolicySetID}}\",\n    \"event\": {\n        \"ip\": \"156.35.85.124\",\n        \"user\": {\n            \"id\": \"{{userID}}\",\n            \"type\": \"EXTERNAL\"\n        }\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/riskEvaluations")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/riskEvaluations",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
      "ip": "156.35.85.124",
      "user": {
        "id": "{{userID}}",
        "type": "EXTERNAL"
      }
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/riskEvaluations',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "riskPolicySet.id": "{{riskPolicySetID}}",
    "event": {
      "ip": "156.35.85.124",
      "user": {
        "id": "{{userID}}",
        "type": "EXTERNAL"
      }
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/riskEvaluations"

payload = json.dumps({
  "riskPolicySet.id": "{{riskPolicySetID}}",
  "event": {
    "ip": "156.35.85.124",
    "user": {
      "id": "{{userID}}",
      "type": "EXTERNAL"
    }
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/riskEvaluations');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "riskPolicySet.id": "{{riskPolicySetID}}",\n    "event": {\n        "ip": "156.35.85.124",\n        "user": {\n            "id": "{{userID}}",\n            "type": "EXTERNAL"\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}}/riskEvaluations")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "riskPolicySet.id": "{{riskPolicySetID}}",
  "event": {
    "ip": "156.35.85.124",
    "user": {
      "id": "{{userID}}",
      "type": "EXTERNAL"
    }
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"riskPolicySet.id\": \"{{riskPolicySetID}}\",\n    \"event\": {\n        \"ip\": \"156.35.85.124\",\n        \"user\": {\n            \"id\": \"{{userID}}\",\n            \"type\": \"EXTERNAL\"\n        }\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/riskEvaluations")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
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()