Description

The global score computes an overall score from some of the other partner technologies. The partner technology that could be included is ThreatMetrix. The weightings are configured in the IFP Portal. The API also returns the scores for the individual technology partner.

When 'Global Score' from Thales is used to make a decision, the result of its analysis is included in decisionDetails under an element named globalScore

Important elements

The table below highlights the important elements to understand when using Global Score from Thales to analyse risks.

Note: In this table, the JSON Path column represents a relative path inside the IdCloud response. Click here for the full path.

Direction	Name	JSON Path	Type	Description	Mandatory	Example
Output	name	name	String	Score name Compliant with following RegEx: ^[^"%&'*,/;<>{}]{1,64}$		"Score with TMX and IAT "
Output	intervals	intervals	array	Intervals resulting from the score composition calculation. minItems=2, maxItems=2, items=Integer		[5,22]
Output	partner_details	partner_details	JSON	A JSON object gathering the details from the partner called in the global score computation.		{ "threametrix": { … } }
Output	threatmetrix	partner_details.threatmetrix	JSON	A JSON object gathering the Threatmetrix elements	false	{ "policy": "gto_atpLogin", "eventType": "LOGIN", "useDefaultScore": true, "score": -50 }
Output	policy	partner_details.threatmetrix.policy	String	The name of the used policy	false	"gto_atpLogin"
Output	eventType	partner_details.threatmetrix.eventType	enum	The type of event	false	"LOGIN"
Output	useDefaultScore	partner_details.threatmetrix.useDefaultScore	Boolean	The usage of DefaultScore entity	false	1
Output	score	partner_details.threatmetrix.score	Integer	The Threatmetrix resulting score	false	-50.0
Output	result	result	Number	Resultant global score that was calculated based on partnerScores and their weight.		"result": 20
Output	rating	rating	String	The resulting rating taken in {"LOW RISK", "MEDIUM RISK", "HIGH RISK"}		"HIGH RISK"

When several scores are used to take the decision, the 'Global Score' contains the information of each of them between curly brackets and separated by a comma.

{
    "id": "5b54d59f-a747-4913-ae03-c4ba54b79bde",
    "name": "Evaluate_Risk",
    "status": "Finished",
    "state": {
        "result": {
            "code": "0",
            "message": "Risk operation completed",
            "type": "Risk_Response",
            "object": {
                "risk": {
                    "status": "SUCCESS",
                    "decision": {
                        "access": "allowed",
                        "auth": [
                            {
                                "type": "password"
                            }
                        ]
                    },
                    "decisionDetails": {
                        "threatmetrix": [
                            {
                                "policyName": "gto_atpLogin",
                                "result": {
                                    "TMX details ...."
                                }
                            }
                        ],
                        "globalScore": [
                            {
                                "name": "Score with TMX",
                                "intervals": [
                                    45,
                                    70
                                ],
                                "partner_details": {
                                    "threatmetrix": {
                                        "eventType": "LOGIN",
                                        "policy": "default",
                                        "score": 90,
                                        "useDefaultScore": false
                                    }
                                },
                                "rating": "LOW RISK",
                                "result": 73
                            }
                        ],
                    },
                    "policy": {
                        "id": "348d6906-56f4-4a41-efcd-4109aacd2bb1",
                        "name": "Example Scores",
                        "scenario": {
                            "id": "e088d416-5401-3ca8-7faa-30f0c0389118",
                            "name": "Aggregated_score"
                        }
                    }
                }
            }
        }
    }
}

globalScore: [
  { global score 1 details} ,
  { global score 2 details} ,
  {…}
]

JSON relative paths

In the tables on this page, the JSON path column contains relative JSON paths.

For easier readability, we have removed the beginning of the JSON path since it is common to all paths. This part is shown below.

You can also check the example section to see a complete response.

{
  "state": {
    "result": {
      "object": {
        "risk": {
          "decisionDetails": {
            "globalScore": "JSON RELATIVE PATH"
          }
        }
      }
    }
  }
}

Suggest A Change

Description

Important elements

JSON relative paths

On this page