https://api.bitsighttech.com/ratings/v1/subsidiaries
See your subsidiaries.
Parameters
Parameter | Description | Values |
---|---|---|
company_guidQuery |
Identify your organization. | [String] Company unique identifier [entity_guid ]. See GET: Portfolio Details.
Default: My Company |
include_subscription_typeQuery |
Filter by subscription type. | [String] my_subsidiary |
Example Request
curl https://api.bitsighttech.com/ratings/v1/subsidiaries -u api_token:
Example Response
{ "requested_company":{ "guid":"a940bb61-33c4-42c9-9231-c8194c305db3", "name":"Saperix, Inc.", "subscription_type_key":"continuous_monitoring" }, "subsidiaries":[ […] { "guid":"819b6a11-d1c6-4518-9566-0611c34d5d8e", "name":"Saperix Hosting Service", "subscription_type_key":"my_subsidiary" } ] }
Response Attributes
Field | Description | ||
---|---|---|---|
requested_companyObject |
The requested company; Your My Company. | ||
guidString [ entity_guid ] |
Your My Company’s unique identifier. | ||
nameString |
Your My Company’s name. | ||
subscription_type_keyString |
The subscription slug name used for your My Company. | ||
subsidiariesArray |
Subsidiaries in your organization. | ||
Object | A subsidiary. | ||
guidString [ entity_guid ] |
This subsidiary’s unique identifier. | ||
nameString |
This subsidiary’s name. | ||
subscription_type_keyString |
The subscription slug name used for this subsidiary. |
Status Codes
See the common errors and status codes.
Code | Description |
---|---|
200 – Okay |
Everything worked as expected. |
400 – Bad Data |
This can often be due to missing a required parameter. |
401 – No Authentication |
No valid API token was provided. |
403 – Unauthorized |
You do not have permission to access this resource. |
404 – Not Found |
The specified resource could not be found or does not exist. |
June 23, 2022: Published.
Feedback
0 comments
Please sign in to leave a comment.