- June 16, 2022: Added
recipient_customer_access
&third_parties
fields. - June 21, 2021: Added
ccs
,context
,requester_email
,resolved_by
, &resolved_date
fields. - September 25, 2020: Published.
https://api.bitsighttech.com/ratings/v1/access-requests/received
View your Collaboration Inbox, which contains all requests received by your organization to collaborate with another company in the Bitsight platform via the Enable Access Program.
Example Request
curl https://api.bitsighttech.com/ratings/v1/access-requests/received -u api_token:
Example Response
[ { "guid":"11111111-eeee-1111-eeee-111111111111", "ccs":"james@blueseas.com", "requester_guid":"11111111-aaaa-1111-aaaa-111111111111", "requester_email":"arnold@actorsfilms.us", "requestee_first_name":"Emma", "requestee_last_name":"Waters", "requester_first_name":"Arnold", "requester_last_name":"Brown", "requester_friendly_name":"Arnold", "requester_formal_name":"Arnold Brown", "requester_company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9", "requester_company_name":"Actors Films", "requester_customer_guid":"cccccccc-4444-cccc-4444-cccccccccccc", "requester_customer_name":"Actors Films", "requestee_friendly_name":"Emma Waters", "requestee_formal_name":"Emma Waters", "requestee_email":"emma@blueseas.com", "requestee_phone":" ", "requestee_company_guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1", "requestee_company_name":"Blue Seas International", "requestee_tos_date":null, "requestee_last_login":"2022-05-23", "message":"Welcome! We use Bitsight Security Ratings to monitor our third parties.", "notes":null, "created_date":"2022-05-11", "created_time":"2022-05-11T18:19:08Z", "email_sent_date":"2022-05-11", "can_resend_email":false, "hubspot_status":"EXISTING", "status":"Active", "is_real":true, "has_shared_observations":false, "has_preferred_contact":false, "shared_observations_count":0, "read":false, "reason":"informational", "context":{ "date":"2022-03-20", "rating":790, "risk_vectors":[ { "grade":"F", "percentile":0, "risk_vector":{ "name":"DNSSEC", "slug":"dnssec" } } ] }, "resolved_by":{ "guid":"11111111-aaaa-1111-aaaa-111111111111", "formal_name":"Arnold Brown" }, "resolved_date":"2022-06-21", "recipient_customer_access":"inactive", "third_parties":[ { "name":"Richard Kuga", "email":"richard.kuga@saperix.com" } ] } ]
Response Attributes
Field | Description | ||||
---|---|---|---|---|---|
guidString [ collab_guid ] |
The unique identifier of the collaboration request. | ||||
ccsString |
An email address that’s carbon copied (CC) on the invitation email. | ||||
requester_guidString [ user_guid ] |
The unique identifier of the sender. | ||||
requester_emailString |
The email address of the sender. | ||||
requestee_first_nameString |
The given name of the recipient. | ||||
requestee_last_nameString |
The surname of the recipient. | ||||
requester_first_nameString |
The given name of the sender. | ||||
requester_last_nameString |
The surname of the sender. | ||||
requester_friendly_nameString |
The preferred name of the sender. | ||||
requester_formal_nameString |
The full name of the sender. | ||||
requester_company_guidString [ entity_guid ] |
The unique identifier of the sender’s company. | ||||
requester_company_nameString |
The name of the sender’s company. | ||||
requester_customer_guidString [ account_guid ] |
The unique identifier of the sender’s account. | ||||
requester_customer_nameString |
The name of the sender’s account. | ||||
requestee_friendly_nameString |
The preferred name of the recipient. | ||||
requestee_formal_nameString |
The full name of the recipient. | ||||
requestee_emailString |
The email address of the recipient. | ||||
requestee_phoneString |
The phone number of the recipient. | ||||
requestee_company_guidString [ entity_guid ] |
The unique identifier of the recipient company. | ||||
requestee_company_nameString |
The name of the recipient company. | ||||
requestee_tos_dateString [ YYYY‑MM‑DD ] |
The date when the recipient accepted the Bitsight Terms and Conditions and activated their account. This value is null if the recipient hasn’t activated their Bitsight account. | ||||
requestee_last_loginString [ YYYY‑MM‑DD ] |
The most recent date when the recipient logged in to the Bitsight platform. | ||||
messageString |
The message from the sender to the recipient. | ||||
notesString |
Private notes from the sender for other users in their organization. This is not visible to recipients. | ||||
created_dateString [ YYYY‑MM‑DD ] |
The date when the collaboration request was submitted. | ||||
created_timeString [ YYYY‑MM‑DDTHH:MM:SSZ ] |
The date and timestamp when the request was submitted. | ||||
email_sent_dateString [ YYYY‑MM‑DD ] |
The date when the invitation email was sent. | ||||
can_resend_emailBoolean |
true = The email can be resent. |
||||
hubspot_statusString |
For internal Bitsight use. | ||||
statusString |
The collaboration status. | ||||
is_realBoolean |
For internal Bitsight use. | ||||
has_shared_observationsBoolean |
true = This request included contextual findings. |
||||
has_preferred_contactBoolean |
true = This company has assigned a user as their preferred contact for receiving invitations to collaborate via the Enable Access Program. |
||||
shared_observations_countInteger |
The number of shared contextual findings. | ||||
readBoolean |
true = This invitation to collaborate has been received and read. |
||||
reasonString |
The reason why your organization was invited to collaborate. | ||||
contextObject |
Context provided by the sender for collaboration. | ||||
dateString [ YYYY‑MM‑DD ] |
The date pertaining to the provided context. | ||||
ratingInteger |
The rating on this date provided as context. | ||||
risk_vectorsArray |
Risk vector grade details. | ||||
Object | The details of the provided context. | ||||
gradeString |
The letter grade of this risk vector. | ||||
percentileDecimal |
|||||
risk_vectorObject |
Details of this risk vector. | ||||
nameString |
The name of this risk vector. | ||||
slugString |
The slug name of this risk vector. | ||||
resolved_byObject |
The sender who marked collaboration as “resolved.” | ||||
guidString [ user_guid ] |
The unique identifier of this user. | ||||
formal_nameString |
The full name of this user. | ||||
resolved_dateString [ YYYY-MM-DD ] |
The date when collaboration was marked as “resolved.” | ||||
recipient_customer_accessString |
The activation status of the recipient. | ||||
third_partiesArray |
Additional recipients that have been added to the Assign CCs field. | ||||
Object | A contact. | ||||
nameString |
This contact’s name. | ||||
|
This contact’s email address. |