GET

Get Score Insights

Use this API to get a count of log-in events grouped by their risk score bucket. You can use the results of this API to determine the risk level of the majority of users which can be useful when deciding the Smart Factor risk level to set.

The risk score bucket ranges are:

  • Minimal (<5)
  • Low (>5 and < 26)
  • Medium (>26 and < 51)
  • High (>51 and <76)
  • Very High (>76)

These ranges are consistent with the Smart Factor settings in the OneLogin policy UI.

Resource URL

https://<subdomain>.onelogin.com/api/2/risk/scores

Header Parameters

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Read All, or Manage All.

Query Parameters

before

string

Optional ISO8601 formatted date string. Defaults to current date. Maximum date is 90 days ago.

after

string

Optional ISO8601 formatted date string. Defaults to 30 days ago. Maximum date is 90 days ago.

Sample Response

  • 200 OK
  • 401 Unauthorized
{
    "scores": {
        "minimal": 50,
        "low": 165,
        "medium": 30,
        "high": 17,
        "very_high": 9
    },
    "total": 271
}

Invalid Access Token

Sample Code

cURL

curl -XGET 'https://<subdomain>.onelogin.com/api/2/risk/scores' \
  -H 'Authorization: Bearer xxxxxxxxxxxxx'
```xml

<h2 id="postman-collection">Postman Collection</h2>

[<img src=https://run.pstmn.io/button.svg alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/2629710-4ff52dab-63b4-4cae-9239-6c1a76e8ec00?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D2629710-4ff52dab-63b4-4cae-9239-6c1a76e8ec00%26entityType%3Dcollection%26workspaceId%3D2a9bbc3a-4259-4faf-9f51-0b7ca1df3fd0)