Read DaVinci Connector Details
GET {{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/detailsThe GET {{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/details operation returns detail information for the connector resource specified by its ID in the request URL.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/details' \
--header 'Authorization: Bearer {{accessToken}}'var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/details")
{
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}}/connectors/{{davinciConnectorID}}/details"
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}}/connectors/{{davinciConnectorID}}/details 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}}/connectors/{{davinciConnectorID}}/details")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();var settings = {
"url": "{{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/details",
"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}}/connectors/{{davinciConnectorID}}/details',
'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}}/connectors/{{davinciConnectorID}}/details"
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}}/connectors/{{davinciConnectorID}}/details');
$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}}/connectors/{{davinciConnectorID}}/details")
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_bodyvar request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/connectors/{{davinciConnectorID}}/details")!,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": {
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectors/pingOneFraudConnector/details"
}
},
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"accountConfigView": {
"items": [
{
"propertyName": "envId"
},
{
"propertyName": "clientId"
},
{
"propertyName": "clientSecret"
},
{
"propertyName": "region"
}
]
},
"capabilities": {
"createFraudEvaluation": {
"type": "action",
"title": "Create Fraud Evaluation Score",
"subTitle": "Create a Fraud risk evaluation score based on the session ID",
"respondToUser": false,
"apiEnabled": true,
"localizedErrors": {
"en": {
"unexpectedError": "Unexpected Error",
"notFound": "Resource Not Found",
"sessionNotFound": "Session not found"
}
},
"payloadInputSchema": {
"default": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"properties": {
"externalSessionId": {
"type": "string"
},
"clientToken": {
"type": "string"
},
"userId": {
"type": "string"
},
"userIdType": {
"type": "string",
"enum": [
"EXTERNAL",
"PING_ONE"
]
},
"action": {
"type": "string",
"enum": [
"login",
"registration",
"search_item",
"view_item",
"click_on_item",
"change_user_info",
"add_user_info",
"confirm_payment",
"add_payment_method",
"view_user_action_history",
"other"
]
},
"clientPlatform": {
"type": "string",
"enum": [
"ANDROID",
"IOS",
"WEB"
]
},
"clientVersion": {
"type": "string",
"maxLength": 128
},
"verbose": {
"type": "boolean"
}
},
"required": [
"externalSessionId",
"clientPlatform",
"action"
]
}
}
}
},
"localOutputSchema": {
"output": {
"type": "object",
"example": {
"rawResponse": {
"id": "43eb5621-eae8-4fa1-aafb-2a884d6848cb",
"environment": {
"id": "9ad15e9e-3ac6-43f7-a053-d46b87d6c4a7"
},
"createdAt": "2022-01-06T10:45:42.555Z",
"updatedAt": "2022-01-06T10:45:42.555Z",
"_embedded": {
"fraudSession": {
"id": "9ad15e9e-eae8-aafb-eae8-d46b87d6c4ad",
"environment": {
"id": "9ad15e9e-3ac6-43f7-a053-d46b87d6c4a7"
},
"createdAt": "2016-04-11T05:20:57.243Z",
"updatedAt": "2016-04-11T05:20:57.243Z",
"active": true,
"externalIds": [
{
"id": "externalId"
}
],
"user": {
"id": "userId",
"type": "EXTERNAL"
}
}
},
"clientToken": "t:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJk",
"session": {
"id": "9ad15e9e-eae8-aafb-eae8-d46b87d6c4a7",
"externalId": "externalId"
},
"user": {
"id": "userId",
"type": "EXTERNAL"
},
"action": "login",
"client": {
"platform": "WEB",
"version": "my.store.com-1.1.1"
},
"details": {
"modules": {
"physicalDevice": {
"level": "HIGH",
"score": 102,
"threshold": {
"scores": [
250,
800,
860
]
},
"clusters": [
"cluster",
"another_cluster"
]
},
"botBehavior": {
"level": "MEDIUM",
"score": 102,
"threshold": {
"scores": [
250,
800,
860
]
},
"clusters": [
"cluster",
"another_cluster"
]
},
"fraudulentBehavior": {
"level": "LOW",
"score": 102,
"threshold": {
"scores": [
250,
800,
860
]
},
"clusters": [
"cluster",
"another_cluster"
]
},
"fraudulentDevice": {
"level": "HIGH",
"score": 102,
"threshold": {
"scores": [
250,
800,
860
]
},
"clusters": [
"cluster",
"another_cluster"
]
}
},
"policies": {
"MIN_FRAUD_MODULE": {
"level": "HIGH_RISK",
"score": 102,
"threshold": {
"scores": [
250,
800,
860
]
},
"clusters": [
"cluster",
"another_cluster"
]
}
},
"indicators": {
"user_typing_usage": {
"value": 3,
"top_indicator": false
},
"session_duration_seconds": {
"value": 4.57,
"top_indicator": true
},
"is_blacklist_ip": {
"value": false,
"top_indicator": false
},
"copy_paste_usage": {
"value": 0,
"top_indicator": false
},
"browser_languages": {
"value": [
"es-ES",
"es"
],
"top_indicator": false
}
}
}
},
"headers": {
"content-type": "application/json;charset=UTF-8"
},
"statusCode": 200,
"level": "HIGH_RISK"
},
"properties": {
"rawResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"environment": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"_embedded": {
"type": "object",
"properties": {
"fraudSession": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"environment": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"active": {
"type": "boolean"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"EXTERNAL",
"PING_ONE"
]
}
},
"required": [
"id",
"type"
]
}
}
}
}
},
"_links": {
"type": "object"
},
"clientToken": {
"type": "string"
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"externalId": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"EXTERNAL",
"PING_ONE"
]
}
},
"required": [
"id",
"type"
]
},
"action": {
"type": "string",
"maxLength": 128
},
"client": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"ANDROID",
"IOS",
"WEB"
]
},
"version": {
"type": "string",
"maxLength": 128
}
}
},
"details": {
"type": "object",
"properties": {
"modules": {
"type": "object"
},
"policies": {
"type": "object"
},
"indicators": {
"type": "object"
}
}
}
},
"required": [
"session"
]
},
"headers": {
"type": "object"
},
"statusCode": {
"type": "integer"
},
"level": {
"type": "string",
"enum": [
"HIGH_RISK",
"MEDIUM_RISK",
"NO_THREAT",
"SAFE"
]
}
},
"required": [
"level",
"rawResponse",
"statusCode",
"headers"
]
}
},
"userViews": [],
"flowConfigView": {
"items": [
{
"propertyName": "externalSessionId"
},
{
"propertyName": "clientToken"
},
{
"propertyName": "userId"
},
{
"propertyName": "userIdType"
},
{
"propertyName": "action"
},
{
"propertyName": "clientPlatform"
},
{
"propertyName": "clientVersion"
},
{
"propertyName": "verbose"
}
]
}
},
"provideSessionFeedback": {
"type": "action",
"title": "Provide session feedback data",
"subTitle": "This service provides a way to enrich PingOne Fraud knowledge about session risk indicators",
"respondToUser": false,
"apiEnabled": true,
"localizedErrors": {
"en": {
"unexpectedError": "Unexpected Error",
"notFound": "Resource Not Found"
}
},
"payloadInputSchema": {
"default": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"properties": {
"externalSessionId": {
"type": "string"
},
"userId": {
"type": "string"
},
"possibleFraud": {
"type": "string",
"enum": [
"NON_FRAUD",
"POSSIBLE_FRAUD"
]
},
"labelType": {
"type": "string"
},
"fraudTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"confidence": {
"type": "string"
}
},
"required": [
"externalSessionId"
],
"if": {
"properties": {
"possibleFraud": {
"const": "NON_FRAUD"
}
}
},
"then": {
"required": [
"externalSessionId",
"possibleFraud"
]
},
"else": {
"required": [
"externalSessionId",
"possibleFraud",
"labelType"
]
}
}
}
}
},
"localOutputSchema": {
"output": {
"type": "object",
"example": {
"statusCode": 200
},
"properties": {
"statusCode": {
"type": "integer"
}
},
"required": [
"statusCode"
]
}
},
"userViews": [],
"flowConfigView": {
"items": [
{
"propertyName": "externalSessionId"
},
{
"propertyName": "userId"
},
{
"propertyName": "possibleFraud"
},
{
"propertyName": "labelType"
},
{
"propertyName": "fraudTypes"
},
{
"propertyName": "confidence"
}
]
}
}
},
"flowSections": [
{
"name": "General",
"value": "general"
}
],
"properties": {
"envId": {
"displayName": "Environment ID",
"preferredControlType": "textField",
"info": "Your PingOne environment ID.",
"required": true,
"sections": [
"pingOneEnvironment"
]
},
"clientId": {
"displayName": "Client ID",
"preferredControlType": "textField",
"info": "The Client ID of your PingOne Worker application.",
"required": true,
"sections": [
"pingOneEnvironment"
]
},
"clientSecret": {
"displayName": "Client Secret",
"preferredControlType": "textField",
"info": "The Client Secret of your PingOne Worker application.",
"hashedVisibility": true,
"required": true,
"sections": [
"pingOneEnvironment"
]
},
"region": {
"displayName": "Region",
"preferredControlType": "dropDown",
"required": true,
"options": [
{
"name": "North America - US",
"value": "NA"
},
{
"name": "North America - Canada",
"value": "CA"
},
{
"name": "Europe",
"value": "EU"
},
{
"name": "Asia - Australia",
"value": "AP"
}
],
"info": "The region in which your PingOne environment exists.",
"sections": [
"pingOneEnvironment"
]
},
"externalSessionId": {
"displayName": "External Session ID",
"preferredControlType": "textField",
"info": "The unique identifier for the session. The same identifier must be used by the PingOne Fraud SDKs for the session.",
"enableParameters": true,
"required": true
},
"clientToken": {
"displayName": "Client Token",
"preferredControlType": "textField",
"info": "This token is used for Fraud BOT detection capabilities and should be passed in every call to the Fraud Evaluations API, whether or not your use case includes bot detection.",
"enableParameters": true
},
"userId": {
"displayName": "User ID",
"preferredControlType": "textField",
"info": "If the user ID Type is PING_ONE, use PingOne's userID. If the user ID Type is EXTERNAL, use a non personal user identifier. Note: only use this field if the user is authenticated.",
"enableParameters": true
},
"userIdType": {
"displayName": "User ID Type",
"preferredControlType": "dropDown",
"options": [
{
"name": "EXTERNAL",
"value": "EXTERNAL"
},
{
"name": "PING ONE",
"value": "PING_ONE"
}
],
"info": "Type of user ID. PING_ONE indicating the user exists in the PingOne directory.",
"value": "EXTERNAL"
},
"action": {
"displayName": "Action",
"preferredControlType": "textField",
"enableParameters": true,
"info": "The context in which the API call is triggered (lowercase). One of the following:\nlogin, registration, search_item, view_item, click_on_item, change_user_info, add_user_info, confirm_payment, add_payment_method, view_user_action_history, other",
"required": true
},
"clientPlatform": {
"displayName": "Client Platform",
"preferredControlType": "textField",
"enableParameters": true,
"info": "The client that triggered the flow (uppercase). One of the following:\nWEB, ANDROID, IOS",
"required": true
},
"clientVersion": {
"displayName": "Client Version",
"preferredControlType": "textField",
"info": "The version of the client used, expressed only in numbers separated by dots (such as 1, 1.2, 1.2.1, etc.)",
"enableParameters": true
},
"verbose": {
"displayName": "Verbose",
"preferredControlType": "toggleSwitch",
"info": "If set to true, returns a list of indicators in the Fraud Evaluations response.",
"value": false
},
"possibleFraud": {
"displayName": "Possible Fraud",
"preferredControlType": "dropDown",
"options": [
{
"name": "NON_FRAUD",
"value": "NON_FRAUD"
},
{
"name": "POSSIBLE_FRAUD",
"value": "POSSIBLE_FRAUD"
}
],
"value": "NON_FRAUD"
},
"labelType": {
"displayName": "Label Type",
"info": "Fraud label label.",
"preferredControlType": "dropDown",
"options": [
{
"name": "FRAUD",
"value": "FRAUD"
},
{
"name": "UNCERTAIN",
"value": "UNCERTAIN"
},
{
"name": "NONE",
"value": "NONE"
}
],
"visibility": [
{
"possibleFraud": "POSSIBLE_FRAUD"
}
],
"value": "FRAUD"
},
"fraudTypes": {
"displayName": "Fraud Types",
"info": "Type of fraudulent event.",
"preferredControlType": "dropDownMultiSelect",
"options": [
{
"name": "ACCOUNT_TAKEOVER",
"value": "ACCOUNT_TAKEOVER"
},
{
"name": "NEW_ACCOUNT_FRAUD",
"value": "NEW_ACCOUNT_FRAUD"
},
{
"name": "PAYMENT",
"value": "PAYMENT"
},
{
"name": "OTHER",
"value": "OTHER"
},
{
"name": "NONE",
"value": "NONE"
}
],
"visibility": [
{
"possibleFraud": "POSSIBLE_FRAUD"
}
]
},
"confidence": {
"displayName": "Confidence",
"info": "Confidence level of the fraud result.",
"preferredControlType": "dropDown",
"options": [
{
"name": "VERY_HIGH",
"value": "VERY_HIGH"
},
{
"name": "HIGH",
"value": "HIGH"
},
{
"name": "MEDIUM",
"value": "MEDIUM"
},
{
"name": "LOW",
"value": "LOW"
},
{
"name": "VERY_LOW",
"value": "VERY_LOW"
}
],
"visibility": [
{
"possibleFraud": "POSSIBLE_FRAUD"
}
]
}
},
"sections": [
{
"name": "PingOne Environment",
"value": "pingOneEnvironment"
}
]
}