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.
Parameter | Values |
---|---|
guid * [Path] Identify the 4th party Security Incident alert to query. |
[Integer] The unique identifier [ |
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. |
[Integer] |
q [Query] Perform a full-text search for matching records on all searchable fields. |
[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 | ||
---|---|---|---|
guidString [ alert_guid ] |
The unique identifier of this alert. | ||
alert_typeString |
The conditions that triggered the alert. See alert categories. | ||
alert_dateString [ YYYY-MM-DD ] |
The date when the alert is generated. | ||
start_dateString [ YYYY-MM-DD ] |
The start date of the alert period. | ||
company_nameString |
The name of the company that triggered the alert. | ||
company_guidString [ entity_guid ] |
The unique identifier of the company that the alert was generated for. | ||
company_urlString |
The URL path to this company’s Overview page in the Continuous Monitoring application. | ||
folder_guidString [ folder_guid ] |
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_nameString |
The name of this folder. | ||
severityString |
The level of change that generated this alert. See change severity. | ||
triggerString |
The type of data that generated this alert. | ||
detailsObject |
The alert details. | ||
categoryString |
The Security Incident category. See: |
||
messageString |
A description of the Public Disclosure that triggered this alert. | ||
subcategoryString |
The Security Incident type. See: |
||
is_directBoolean |
true = This company was the original target within a multiparty event. |
||
severityInteger |
The severity of the Public Disclosures event. Values: |
||
discovery_dateString [ YYYY-MM-DD ] |
The earliest date when information pertaining to the security incident or self-discovery date became publicly available or when affected parties were notified. | ||
effective_dateString [ YYYY-MM-DD ] |
The date when a Security Incident event was recorded in the Bitsight platform. | ||
public_disclosure_guidString [ breach_guid ] |
The Public Disclosure’s unique identifier. | ||
origin_typeString |
The Public Disclosure origin type. Values: |
||
origin_companyObject |
The origin company’s details. | ||
guidString [ entity_guid ] |
This company’s unique identifier. | ||
nameString |
This company’s name. | ||
display_urlString |
The URL path to this company’s Overview page in the Continuous Monitoring application. | ||
is_subscribedBoolean |
true = You are subscribed to this company. |
Status Codes
Code | Description |
---|---|
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. |
Feedback
0 comments
Please sign in to leave a comment.