https://api.bitsighttech.com/ratings/v1/companies/company_guid/findings?risk_vector=dkim
Get an organization’s DKIM Record finding details.
Parameters
For details specific to DKIM Records, use the ?risk_vector=dkim
parameter. Other query parameters are listed in GET: Finding Details.
Parameter | Values |
---|---|
company_guid [Path] Identify the company to query. |
[String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
Example Request
curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/findings?risk_vector=dkim -u api_token:
Example Response
{ "links":{ "next":null, "previous":null }, "count":3, "results":[ […] { "temporary_id":"A9Jq47BBje45efb91a6bf4f53a09f04c04920967ee", "affects_rating":true, "assets":[ { "asset":"saperix.edu", "identifier":null, "category":"critical", "importance":0.1, "is_ip":false } ], "details":{ "check_pass":" ", "diligence_annotations":{ "message":"Public key size is less than 2048 bits", "answer":[ { "algorithm":"rsa", "keylen":1024, "record":[ "TXT", "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJCqe+Ry6DXWV9gLsv4HFjZkFymu4j9A/NzqzfGl2WxfXY9hIU7f1KbEKsMxhXykJIq5YkknGr4Q5hP1xPhsL33DQCCGWCWwN6BlQcApeOgftqKwEU5Qeb5UisfOQ/fCgtYEwnnpmDNplPcnTouiq0eUPX7P6EJa2jPZ/lS/RT2wIDAQAB" ] } ] }, "grade":"WARN", "remediations":[ { "message":"Public key size is less than 2048 bits", "help_text":"Keys shorter than 2048 bits may be insecure.", "remediation_tip":"Use OpenSSL or SSL implementation of your choice to generate a new keypair, and specify 2048 bits or greater of key strength at generation. Implement the stronger keypair into your DKIM configuration." } ], "sample_timestamp":"2022-09-10T20:43:45Z", "vulnerabilities":[ ], "rollup_end_date":"2022-09-10", "rollup_start_date":"2022-09-10", "searchable_details":"Public key size is less than 2048 bits" }, "evidence_key":"default._domainkey.saperix.edu", "first_seen":"2022-09-10", "last_seen":"2022-09-10", "related_findings":[ ], "risk_category":"Diligence", "risk_vector":"dkim", "risk_vector_label":"DKIM", "rolledup_observation_id":"De6pm7kPUR_t9JGzwim6wA==", "severity":6.0, "severity_category":"moderate", "tags":[ ], "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":42 } ] }
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 |
Assets and their details. | ||||||
Object | An asset (IP address or domain). | ||||||
asset String |
The asset associated with this finding. | ||||||
identifier Null |
For internal Bitsight use. | ||||||
category String |
The Bitsight-calculated asset importance. | ||||||
importance Decimal |
Reiterates the category field. See asset importance. | ||||||
is_ip Boolean |
true = This asset is an IP address. | ||||||
details Object |
Finding details. | ||||||
check_pass String |
For internal Bitsight use. | ||||||
diligence_annotations Object |
Diligence finding details. | ||||||
message String |
Indicates if the DKIM record is effective. | ||||||
answer Array |
DKIM records and their details. | ||||||
Object | A DKIM record. | ||||||
algorithm String |
The algorithm used to encrypt and decrypt messages. | ||||||
keylen Integer |
The bit strength of this key. See key length recommendations. | ||||||
record Array |
The DKIM record. | ||||||
grade String |
The finding grade. | ||||||
remediations Array |
Information about a finding and instructions to remediate it. | ||||||
Object | A finding. | ||||||
message String |
The display name of this finding. | ||||||
help_text String |
Details of this finding. | ||||||
remediation_tip String |
The recommended remediation instructions. | ||||||
sample_timestamp String [ |
The date and time when this finding was observed. | ||||||
vulnerabilities Array |
This is not applicable to DKIM Record findings. | ||||||
rollup_end_date String [ |
The date when this finding was last observed. | ||||||
rollup_start_date String [ |
The date when this finding was first observed. | ||||||
searchable_details String |
An indication of the effectiveness of the DKIM record. | ||||||
evidence_key String |
The asset attributed to the finding. | ||||||
first_seen String [ |
The date when this observation was first observed. | ||||||
last_seen String [ |
The date when this observation was last observed. | ||||||
related_findings Array |
Details of related findings. | ||||||
risk_category String |
The risk category associated with this finding. | ||||||
risk_vector String |
The slug name of the risk vector. | ||||||
risk_vector_label String |
The display name of the 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 |
This finding’s Bitsight severity value. | ||||||
severity_category String |
This finding’s Bitsight severity. | ||||||
tags Array |
Infrastructure tags identifying the asset. | ||||||
remediation_history Object |
If ?expand=remediation_history parameter is set, the remediation history of the finding is included. |
||||||
last_requested_refresh_date String [ |
The date when a finding rescan that included this finding was last requested. | ||||||
last_refresh_status_date String [ |
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 resacn 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 |
Finding comments. | ||||||
remaining_decay Integer |
The remaining finding lifetime. |
-
February 28, 2025: Added
last_refresh_status_reason
,last_refresh_reason_code
,last_refresh_requester
, andresult_finding_date
response attributes. - November 18, 2022: Published.
Feedback
0 comments
Please sign in to leave a comment.