Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Target Of Evaluation TOE

This resource returns a collection of `TOE` objects mapped to a customer.

This API retrieves a collection of TOE objects mapped to a customer. This include overall ratings and some domain rating information for the current analysis of the provided TOE id. As a TOE can have multiple internal IDs, this API filters if the internal ID is one among the multiple internal IDs.

get/v1/toes_paginated

Query parameters

internal_id[]string[]

This parameter filters results by internal_id. A TOE can actually have multiple internal_ids so it will filter if the given internal_id is one of them (if there are multiple).

[
  "12345"
]
last_retrievedstring
Example:2020-11-20

Filter results published or updated after the provided date string in format YYYY-MM-DD. An example request would like like ?last_retrieved=2020-11-20 and this would grab results updated on or after 2020-11-20.

pageinteger
Example:1

This parameter is the page number in routes that have pagination.

per_pageinteger
Example:20

This parameter sets the results limit per page. This defaults to 20 and currently has a max of 250.

risk_dimensions[]string[]

This parameter filters results by array of RiskDimensions. Defaults to cyber. privacy is a new option for customers with privacy licenses. ?risk_dimensions[]=privacy&risk_dimensions[]=cyber

[
  "cyber"
]
sort_method'ASC' | 'DESC'
Example:DESC

Sort results by ascending or descending order.

toe_idstring
Example:5976423a-ee35-11e3-8569-14109ff1a304

Filter by the Toe ID.

sort_attribute'toe_short_name' | 'date_updated'
Example:toe_short_name

This parameter is optional but allows the user to sort results of paginated TOEs by available sort attributes.

Response

OK

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10
  },
  "data": [
    {
      "attributes": {
        "toe_short_name": "Riskrecon, CO.",
        "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
        "ticker_symbols": [
          {
            "ticker_symbol": "0023.HK",
            "exchange_name": "NYSE"
          }
        ],
        "analysis_id": "12345",
        "date_updated": "2020-07-24T02:35:58Z",
        "seed_hostnames": [
          "riskrecon.com"
        ],
        "risk_configurations": [
          {
            "risk_relationship": "Own Enterprise",
            "inherent_risk": "Critical"
          }
        ],
        "internal_name": [
          "Riskrecon"
        ],
        "internal_id": [
          "1234"
        ],
        "duns_numbers": [
          "12345"
        ],
        "frequency": "continuous",
        "subscription_level": "advisor",
        "privacy_subscription_level": "advisor",
        "cyber_rating": "a",
        "cyber_rating_numeric": 9,
        "privacy_rating": "a",
        "privacy_rating_numeric": 9,
        "security_domain_ratings": [
          {
            "security_domain": "patching_app_server",
            "rating": "a",
            "rating_numeric": 9,
            "risk_dimension": "cyber",
            "display_name": "OpenSSL Patching",
            "rated": true
          }
        ]
      },
      "id": "5976423a-ee35-11e3-8569-14109ff1a304",
      "type": "toe"
    }
  ]
}