https://api.bitsighttech.com/ratings/v2/alerts/alert_guid/affected-companies
Get companies that were indirectly affected by a 4th party Public Disclosure.
Available for Third Party Risk Management.
Parameters
* Required.
guid
-
* Required.
[Path] Identify the 4th party Security Incident alert to query.
Value: [Integer] The unique identifier [
alert_guid
] of a 4th Party Security Incident alert. See GET: Alerts. - limit
-
[Query] Set the maximum number of results. The results might include fewer records (even zero), but not more.
[Integer] ↻32
(default) - offset
-
[Query] Set the starting point of the return.
Value: [Integer]
0
(zero) = Start from the first record in the result set. - q
-
[Query] Perform a full-text search for matching records on all searchable fields.
Value: [String]
Example Request
curl https://api.bitsighttech.com/ratings/v2/alerts/24990834/affected-companies -u api_token:
Example Response
{ "guid": "24990834", "alert_type": "PUBLIC_DISCLOSURE", "alert_date": "2020-06-04", "start_date": "2020-06-03", "company_name": "Saperix", "company_guid": "35fbbd59-6bae-87ba-22418b40a6bb", "company_url": "/company/35fbbd59-6bae-87ba-22418b40a6bb/", "folder_guid": "45bc7bi4-fold-4a39-a81e-8b37c2b3ba2f", "folder_name": "Total Risk Monitoring" "severity": "CRITICAL", "trigger": "Patching Cadence", "details": { "category": "General Security Incident", "message": "Perix, SA disclosed the personal information of an unknown number of individuals to an unauthorized third party.", "subcategory": "Human Error", "is_direct": false, "severity": 0, "discovery_date": "2020-06-04", "effective_date": "2020-06-03", "public_disclosure_guid": "45bc7bi4-fold-4a39-a81e-8b37c2b3ba2f", "origin_type": "subsidiary", "origin_company":{ "guid": "45bc7bi4-4a39-sube-8b37c2b3ba2f", "name": "Perix, SA", "display_url": "/company/45bc7bi4-4a39-sube-8b37c2b3ba2f/", "is_subscribed": false, }, } }
Response Attributes
Field | Description | ||
---|---|---|---|
guid String [ |
The unique identifier of this alert. | ||
alert_type String |
The conditions that triggered the alert. See alert categories. | ||
alert_date String [ |
The date when the alert is generated. | ||
start_date String [ |
The start date of the alert period. | ||
company_name String |
The name of the company that triggered the alert. | ||
company_guid String [ |
The unique identifier of the company that the alert was generated for. | ||
company_url String |
The URL path to this company’s Overview page in the Continuous Monitoring application. | ||
folder_guid String [ |
The unique identifier of the folder for which the alert was created. This is your “All Companies” folder if the company was not in a specific folder. | ||
folder_name String |
The name of this folder. | ||
severity String |
The level of change that generated this alert. See change severity. | ||
trigger String |
The type of data that generated this alert. | ||
details Object |
The alert details. | ||
category String |
The Security Incident category. See: |
||
message String |
A description of the Public Disclosure that triggered this alert. | ||
subcategory String |
The Security Incident type. See: |
||
is_direct Boolean |
true = This company was the original target within a multiparty event. |
||
severity Integer |
The severity of the Public Disclosures event. Values: |
||
discovery_date String [ |
The earliest date when information pertaining to the security incident or self-discovery date became publicly available or when affected parties were notified. | ||
effective_date String [ |
The date when a Security Incident event was recorded in the Bitsight platform. | ||
public_disclosure_guid String [ |
The Public Disclosure’s unique identifier. | ||
origin_type String |
The Public Disclosure origin type. Values: |
||
origin_company Object |
The origin company’s details. | ||
guid String [ |
This company’s unique identifier. | ||
name String |
This company’s name. | ||
display_url String |
The URL path to this company’s Overview page in the Continuous Monitoring application. | ||
is_subscribed Boolean |
true = You are subscribed to this company. |
Status Codes
200 – Okay
- Everything worked as expected.
404 – Not Found
- The specified resource could not be found.
422 – Not Processed
- The request could not be processed.
- April 25, 2023: Published.
Feedback
0 comments
Please sign in to leave a comment.