GET: Desktop Software Finding Details

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/company_guid/findings?risk_vector=desktop_software

Get an organization’s Desktop Software finding details.

Parameters

For details specific to Desktop Software, use the ?risk_vector=desktop_software parameter. Other query parameters are listed in GET: Finding Details.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/findings?risk_vector=desktop_software -u api_token:

Example Response

{
  "links":{
    "next":"https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/findings?limit=100&offset=100&risk_vector=desktop_software",
    "previous":null
  },
  "count":266,
  "results":[
    {
      "temporary_id":"A9Jq47BBje16e6e8d144bd8121cb4b4b2c941579f5",
      "affects_rating":true,
      "assets":[
        {
          "asset":"24.6.16.69",
          "identifier":null,
          "category":"low",
          "importance":0.0,
          "is_ip":true
        }
      ],
      "details":{
        "cvss":{
          "base":[ ]
        },
        "check_pass":"",
        "estimation_of_users":"1",
        "diligence_annotations":{
          "count_ips":1,
          "operating_system_rule":{
            "version":"10.15.7",
            "eol":"9999-01-01",
            "launch":"2020-09-24",
            "is":"match"
          },
          "user_agent_rule":{
            "version":"113",
            "eol":"2023-06-06",
            "launch":"2023-05-02",
            "is":"match"
          },
          "sample_ips":[
            "24.6.16.69"
          ],
          "sample_user_agent_strings":[
            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36"
          ],
          "sample_domains":[
            "avgle.com"
          ]
          "sample_records": [
            {
              "ip": "63.208.139.45",
              "timestamp": "timestamp",
              "user_agent": "Mozilla/5.0 (X11; CrOS x86_64 14541.0.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
              "domain": "www.dictionary.com"
            }
          ]
        },
        "geo_ip_location":"US",
        "country":"United States",
        "grade":"GOOD",
        "operating_system_family":"Mac OS X",
        "operating_system_grade":"GOOD",
        "operating_system_name":"macOS",
        "operating_system_support_status":"SUPPORTED",
        "operating_system_version":"10.15.7",
        "remediations":[
          {
            "message":"Supported Operating System and Browser",
            "help_text":"The operating system and browser are both supported.",
            "remediation_tip":""
          }
        ],
        "sample_timestamp":"2023-06-09T23:59:59Z",
        "user_agent_family":"Chrome",
        "user_agent_grade":"GOOD",
        "user_agent_support_status":"SUPPORTED",
        "user_agent_version":"113",
        "vulnerabilities":[ ],
        "rollup_end_date":"2023-06-09",
        "rollup_start_date":"2023-05-19",
        "searchable_details":"Supported Operating System and Browser"
      },
      "evidence_key":"Mac OS X 10.15.7 / Chrome 113.0.0",
      "first_seen":"2023-05-19",
      "last_seen":"2023-06-09",
      "related_findings":[ ],
      "risk_category":"Diligence",
      "risk_vector":"desktop_software",
      "risk_vector_label":"Desktop Software",
      "rolledup_observation_id":"kkMa1MuYiptCdylSJzGDoA==",
      "severity":1.0,
      "severity_category":"minor",
      "tags":[
        "Widget Division"
      ],
      "remediation_history":{
        "last_requested_refresh_date":"2024-06-19",
          "last_refresh_status_date":"2024-06-23",
          "last_refresh_status_label":"failed",
        "last_refresh_status_reason": "asset_not_found",
          "last_refresh_reason_code":"asset unreachable",
          "last_refresh_requester": "1e10564d-fawa-4331-0000-6f7588b55a98",
        "result_finding_date": null
      },
      "asset_overrides":[ ],
      "duration":null,
      "comments":null,
      "remaining_decay":62,
      "remediated":null
    },
    […]
  ]
}

Response Attributes

Field						Description
links Object						Navigation for multiple pages of results. See pagination.
	next String					The URL for navigating to the next page of results.
	previous String					The URL for navigating to the previous page of results.
count Integer						The number of findings.
results Array						Findings and their details.
	Object					A finding.
		temporary_id String				A temporary identifier for this finding.
		affects_rating Boolean				true = This finding impacts the risk vector letter grade.
		assets Array				Asset (IP address or domain) details.
			Object			An asset.
				asset String		The asset associated with this finding.
				identifier Null		For internal Bitsight use.
				category String		The Bitsight-calculated asset importance.
				importance Decimal		The Bitsight-calculated asset importance.
				is_ip Boolean		`true` = This asset is an IP address.
		details Object				Finding details.
			cvss Object			If the finding has an associated vulnerability, this contains the CVSS score.
				base Array		CVSS scores of vulnerabilities associated with this finding.
			check_pass String			For internal Bitsight use.
			estimation_of_users String			The estimated number of affected users.
			diligence_annotations Object			Diligence finding details.
				count_ips Integer		The number of IP addresses attributed to this finding.
				operating_system_rule Object		Details of the logic for determining the supported status of the operating system.
					version String	The OS version.
					eol String [`YYYY-MM-DD`]	The OS end-of-life date.
					launch String [`YYYY-MM-DD`]	The OS launch date.
					is String
				user_agent_rule Object		Details of the logic for determining the supported status of the user’s operating system.
					version String	The OS version.
					eol String [`YYYY-MM-DD`]	The OS end-of-life date.
					launch String [`YYYY-MM-DD`]	The OS launch date.
					is String
				sample_ips Array		A sampled list of attributed IP addresses.
				sample_user_agent_strings Array		Sample user-agent strings, as sent by the browser.
				sample_domains Array		Sample domains.
				sample_records Array		Sample records.
					ip String	The source IP address of the connection when the evaluated desktop made an outbound request. This is typically an IP address associated with a firewall. The source IP and user-agent string are used to determine the OS and browser version.
					timestamp String	Date and time (in UTC) the traffic was observed.
					user_agent String	The `user-agent` string in the header, which identifies end-user interactions with web content. The details include the application, operating system, browser, and software version.
					domain String	The target host that the browser connected with (if available). If we were able to collect target host information, it is useful for searching the firewall logs to determine which internal host made the connection. Search for the egress IP in the source IP field, the target host, and representative timestamp.
			geo_ip_location String			A 2-letter ISO country code indicating this finding’s country of origin.
			country String			This finding’s country of origin.
			grade String			The finding grade.
			operating_system_family String			The OS type.
			operating_system_grade String			An assessment of this OS. See graded OS.
			operating_system_name String			The OS name.
			operating_system_support_status String			The operating system’s support status.
			operating_system_version String			The OS version.
			remediations Array			Information about the finding and instructions to remediate it, if any.
				Object		The information.
					message String	Details of this finding.
					help_text String	An overview of this finding.
					remediation_tip String	The recommended remediation instructions.
			sample_timestamp String [`YYYY-MM-DDTHH:MM:SSZ`]			The date and time when this finding was observed.
			user_agent_family String			The user’s browser type.
			user_agent_grade String			An assessment of this browser. See graded browsers.
			user_agent_support_status String			The browser’s support status.
			user_agent_version String			The current version of this browser.
			vulnerabilities Array			Not applicable to Desktop Software findings.
			rollup_end_date String [`YYYY-MM-DD`]			The date of the most recent observation.
			rollup_start_date String [`YYYY-MM-DD`]			The date when this finding was first observed.
			searchable_details String			Details that can be searched in the Bitsight platform.
		evidence_key String				The asset attributed to the finding.
		first_seen String [`YYYY-MM-DD`]				The date when an observation was first seen.
		last_seen String [`YYYY-MM-DD`]				The date when an observation was last seen.
		related_findings Array				Related findings and their details.
		risk_category String				The risk category of this finding.
		risk_vector String				The slug name of this risk vector.
		risk_vector_label String				The display name of this risk vector.
rolledup_observation_id String				A stable and randomized identifier for findings. It is assigned to a finding when one or more observations with largely similar key properties occur in close succession.
severity Decimal				The finding severity, which is the measured risk that this finding introduces.
severity_category String				The finding severity slug name.
tags Array				Infrastructure tags that identify this asset.
remediation_history Object				The finding’s remediation and refresh history.
		last_requested_refresh_date String [`YYYY‑MM‑DD`]			The date when a finding rescan that included this finding was last requested.
		last_refresh_status_date String [`YYYY‑MM‑DD`]		The date when a rescan of the remediation status of this finding was last requested.
		last_refresh_status_label String		The current rescan status of this finding.
	last_refresh_status_reason String			The rescan status.
		last_refresh_reason_code String		The reason code for the rescan status.
		last_refresh_requester String [`user_guid`]		The unique identifier of the user who requested the rescan.
	result_finding_date String [`YYYY-MM-DD`]			The first seen date of the finding that resulted from the rescan, if applicable.
asset_overrides Array				User-assigned asset importance details.
duration Integer				For internal Bitsight use.
comments String				A thread of finding comments.
remaining_decay Integer [`Calendar Days`]				The remaining finding lifetime.
remediated Boolean				`true` = The finding is remediated.

October 16, 2024: sample_records:domain is "target host" and updated description; sample_records:ip is "source IP" and updated description.
March 11, 2024: Added sample_records, ip, timestamp, user_agent, and domain response attributes.
September 26, 2023: Published.