BitSight Community MCP Server

{"components":{"parameters":{"FormatIncludeCSV":{"description":"format of response data","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","xml","csv"],"type":"string"}},"Limit":{"description":"the maximum number of records to return in a response. If not set, will return all records\n","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}},"Offset":{"description":"the offset in the result set to start returning records from. The value 0 will cause the results to start with the first record of the result set.\n","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},"Query":{"description":"the string to use to search for matching records. This will perform a full-text search on all searchable fields.\n","in":"query","name":"q","schema":{"type":"string"}},"Sort":{"description":"the fields to sort the response objects by. Field names are simply the name of the field in the response object. Multiple fields can be specified by comma-separating their names. Specifying a field sorts it in ascending order (A->Z). To sort in reverse (descending) order, place a minus sign (-) immediately before the field name. Ex, 'product_name,-provider_name' will sort first by product_name ascending, then by provider_name descending (where the product_name is the same)\n","in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}}},"responses":{"BadData":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad data"},"Conflict":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Conflict with current state of target resource"},"InternalServerError":{"description":"Internal Server Error"},"NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The specified resource was not found"},"PermissionDenied":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission Denied for this action"},"ServiceUnavailable":{"description":"Server is not ready to handle the request"},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized"},"Unprocessable":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Requested object can not be processed"}},"schemas":{"AffectedCompanies":{"properties":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"items":{"properties":{"guid":{"description":"GUID of the affected company","example":"d004824b-b94b-4b5f-89d0-5a0921890a25","readOnly":true,"type":"string"},"is_subscribed":{"description":"Whether the affected company is still subscribed.","example":true,"readOnly":true,"type":"boolean"},"name":{"description":"Name of the affected company.","example":"Acme Corp.","readOnly":true,"type":"string"},"rating":{"description":"Current rating of the affected company if it is subscribed, otherwise null.","example":450,"nullable":true,"readOnly":true,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"Alert":{"properties":{"alert_date":{"description":"First name of the requestee","format":"date","readOnly":true,"type":"string"},"alert_type":{"description":"The type of alert","readOnly":true,"type":"string"},"company_custom_id":{"description":"A customer provided custom id for the organization","readOnly":true,"type":"string"},"company_guid":{"description":"GUID of the company","format":"uuid","maxLength":36,"type":"string"},"company_name":{"description":"The name of the company","readOnly":true,"type":"string"},"company_url":{"description":"URL of the company","readOnly":true,"type":"string"},"details":{"properties":{"category":{"description":"The category of alert if this is an INFORMATIONAL, SERVICE_PROVIDER or PUBLIC_DISCLOSURE alert","readOnly":true,"type":"string"},"effective_date":{"description":"The effective date the public disclosure was added to the Bitsight platform, if this is PUBLIC_DISCLOSURE or a FP_PUBLIC_DISCLOSURE alert","readOnly":true,"type":"string"},"end_grade":{"description":"The grade after the alert triggered if this is a RISK_CATEGORY or NIST_CATEGORY alert","readOnly":true,"type":"string"},"end_rating":{"description":"The conmpany's security rating after the alert triggered if this is a PERCENT_CHANGE or RATING_THRESHOLD alert.","readOnly":true,"type":"integer"},"message":{"description":"A message for this alert","readOnly":true,"type":"string"},"nist_category":{"description":"The NIST CSF category (i.e. 'RS.MI') of the NIST_CATEGORY alert","readOnly":true,"type":"string"},"nist_category_display_name":{"description":"The NIST CSF category display name (i.e. 'Mitigation') of this NIST_CATEGORY alert","readOnly":true,"type":"string"},"rating_change_pct":{"description":"The percent change in security scores if this is a PERCENT_CHANGE alert.","readOnly":true,"type":"integer"},"rating_threshold":{"description":"The rating threshold that was crossed to generate the alert if this is a RATING_THRESHOLD alert.","readOnly":true,"type":"integer"},"risk_vector":{"description":"The risk vector that this alert is for if this is a RISK_CATEGORY alert.","readOnly":true,"type":"string"},"start_grade":{"description":"The grade before the alert triggered if this is a RISK_CATEGORY or NIST_CATEGORY alert","readOnly":true,"type":"string"},"start_rating":{"description":"The company's security rating before the alert triggered if this is a PERCENT_CHANGE or RATING_THRESHOLD alert.","readOnly":true,"type":"integer"},"threshold_grade":{"description":"The grade that was reached or crossed to generate the RISK_CATEGORY or NIST_CATEGORY alert","readOnly":true,"type":"string"}},"type":"object"},"folder_guid":{"description":"GUID of the folder","format":"uuid","maxLength":36,"type":"string"},"folder_name":{"description":"The name of the folder that this alert was for","readOnly":true,"type":"string"},"guid":{"description":"GUID of the alert","format":"uuid","maxLength":36,"type":"string"},"severity":{"description":"The severity level of the alert.","readOnly":true,"type":"string"},"start_date":{"description":"Last name of the requestee","format":"date","readOnly":true,"type":"string"},"trigger":{"description":"The trigger for the alert.","readOnly":true,"type":"string"}},"type":"object"},"Alerts":{"properties":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"items":{"$ref":"#/components/schemas/Alert"},"type":"array"}},"type":"object"},"ApiError":{"properties":{"detail":{"description":"the detail about the errors","type":"string"},"status":{"description":"HTTP error code","format":"int32","type":"integer"},"title":{"description":"basic error description","type":"string"}},"type":"object"},"Company":{"properties":{"guid":{"format":"uuid","title":"Guid","type":"string"},"name":{"title":"Name","type":"string"}},"required":["guid","name"],"title":"Company","type":"object"},"CompanyComplianceClaim":{"properties":{"certifications":{"items":{"properties":{"name":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"type":"array"},"guid":{"example":"a940bb61-33c4-42c9-9231-c8194c305db3","format":"uuid","maxLength":36,"type":"string"},"trust_page":{"type":"string"}},"type":"object"},"CompanyIndustry":{"properties":{"name":{"description":"The name of the industry sector","nullable":true,"type":"string"},"slug":{"description":"The slug name of the industry sector","nullable":true,"type":"string"}},"type":"object"},"CompanyLifeCycle":{"nullable":true,"properties":{"name":{"description":"The name of the company's current life cycle, e.g. \"Onboarding\"","nullable":true,"type":"string"},"slug":{"description":"The slug name of the company's current life cycle","nullable":true,"type":"string"}},"type":"object"},"CompanyRelationship":{"nullable":true,"properties":{"name":{"description":"The name of the company's relationship to the requestor, e.g. \"Vendor\"","nullable":true,"type":"string"},"slug":{"description":"The slug name of the company's relationship to the vendor","nullable":true,"type":"string"}},"type":"object"},"CompanyRequest":{"description":"A company request","properties":{"company":{"description":"Associated company, if the request was fulfilled successfuly","properties":{"can_subscribe":{"description":"Indicates if you can subscribe the company","readOnly":true,"type":"boolean"},"can_view":{"description":"Indicates if you have permission to view the company","readOnly":true,"type":"boolean"},"guid":{"description":"Company GUID","readOnly":true,"type":"string"},"in_portfolio":{"description":"Indicates if the company is subscribed","readOnly":true,"type":"boolean"},"is_bundle":{"description":"Indicates if the company is a ratings bundle","readOnly":true,"type":"boolean"},"name":{"description":"Company name","readOnly":true,"type":"string"},"self_published":{"description":"When the company is self published, indicates if its private or public","enum":["public","private"],"nullable":true,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"created_time":{"description":"Time the request was created","format":"date-time","readOnly":true,"type":"string"},"domain":{"description":"The primary domain representing the requested organization","type":"string"},"guid":{"description":"GUID for this company request","readOnly":true,"type":"string"},"requester":{"description":"User who made the company request","properties":{"formal_name":{"description":"User formal name","readOnly":true,"type":"string"},"guid":{"description":"User GUID","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"status":{"description":"Status of the reques","readOnly":true,"type":"string"},"subscription_type":{"description":"Optional subscription type, used if we want to subscribe a company when the request is fulfilled\n","example":"continuous_monitoring","type":"string"},"updated_time":{"description":"Time the request was updated","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"CompanyRequestsResponse":{"description":"A paginated set of company requests","properties":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"description":"A list of company requests","items":{"$ref":"#/components/schemas/CompanyRequest"},"type":"array"}},"type":"object"},"CompanySubIndustry":{"properties":{"name":{"description":"The name of the sub-industry","nullable":true,"type":"string"},"slug":{"description":"The slug name of the sub-industry","nullable":true,"type":"string"}},"type":"object"},"CompanySubscriptionType":{"properties":{"name":{"description":"The name of the company's subscription type, e.g. \"Total Risk Monitoring\"","nullable":true,"type":"string"},"slug":{"description":"The slug name of the company's subscription type","nullable":true,"type":"string"}},"type":"object"},"CountryCode":{"description":"An enumeration.","enum":["AW","AF","AO","AI","AX","AL","AD","AE","AR","AM","AS","AQ","TF","AG","AU","AT","AZ","BI","BE","BJ","BQ","BF","BD","BG","BH","BS","BA","BL","BY","BZ","BM","BO","BR","BB","BN","BT","BV","BW","CF","CA","CC","CH","CL","CN","CI","CM","CD","CG","CK","CO","KM","CV","CR","CU","CW","CX","KY","CY","CZ","DE","DJ","DM","DK","DO","DZ","EC","EG","ER","EH","ES","EE","ET","FI","FJ","FK","FR","FO","FM","GA","GB","GE","GG","GH","GI","GN","GP","GM","GW","GQ","GR","GD","GL","GT","GF","GU","GY","HK","HM","HN","HR","HT","HU","ID","IM","IN","IO","IE","IR","IQ","IS","IL","IT","JM","JE","JO","JP","KZ","KE","KG","KH","KI","KN","KR","KW","LA","LB","LR","LY","LC","LI","LK","LS","LT","LU","LV","MO","MF","MA","MC","MD","MG","MV","MX","MH","MK","ML","MT","MM","ME","MN","MP","MZ","MR","MS","MQ","MU","MW","MY","YT","NA","NC","NE","NF","NG","NI","NU","NL",false,"NP","NR","NZ","OM","PK","PA","PN","PE","PH","PW","PG","PL","PR","KP","PT","PY","PS","PF","QA","RE","RO","RU","RW","SA","SD","SN","SG","GS","SH","SJ","SB","SL","SV","SM","SO","PM","RS","SS","ST","SR","SK","SI","SE","SZ","SX","SC","SY","TC","TD","TG","TH","TJ","TK","TM","TL","TO","TT","TN","TR","TV","TW","TZ","UG","UA","UM","UY","US","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","ZA","ZM","ZW"],"title":"CountryCode"},"Currency":{"description":"An enumeration.","enum":["HUF","NZD","ROL","TRY","TRL","SEK","IDR","GBP","LVL","THB","SIT","MXN","KRW","BRL","DKK","EUR","HKD","CYP","MYR","RUB","SKK","ZAR","PHP","USD","CNY","PLN","JPY","CAD","SGD","ISK","HRK","MTL","EEK","ILS","NOK","CZK","BGN","LTL","RON","AUD","INR","CHF"],"title":"Currency"},"Customer":{"properties":{"guid":{"format":"uuid","title":"Guid","type":"string"},"name":{"title":"Name","type":"string"}},"required":["guid","name"],"title":"Customer","type":"object"},"CyberInsurance":{"properties":{"attachment_point":{"minimum":0,"title":"Attachment Point","type":"integer"},"deductible":{"minimum":0,"title":"Deductible","type":"integer"},"limit":{"minimum":0,"title":"Limit","type":"integer"},"premium":{"minimum":0,"title":"Premium","type":"integer"}},"title":"CyberInsurance","type":"object"},"DamageType":{"description":"An enumeration.","enum":["extortion_payment","extortion_recovery_expenses","bi_recovery_expenses","lost_income","public_relations_repairment","forensics","data_recovery","monitoring_services","notifications","settlements","legal_defense","regulatory_legal_defense","regulatory_fines"],"title":"DamageType","type":"string"},"EmployeeCount":{"description":"An enumeration.","enum":["0-10","10-50","50-100","100-500","500-1000","1000-5000","5000-10000","10000-50000","50000-100000","100000+"],"title":"EmployeeCount","type":"string"},"Error":{"properties":{"detail":{"type":"string"}},"type":"object"},"FQOutput":{"description":"Output data returned by the model. For legacy FQs, in the case of the level1 output, these fields will all be empty and in the case of level2_3, annualized_loss will be empty. Signals and scores will always be empty for legacy, as well.","properties":{"level1":{"$ref":"#/components/schemas/FQOutputLevel"},"level2_3":{"$ref":"#/components/schemas/FQOutputLevel"},"scores":{"$ref":"#/components/schemas/FQOutputScores"},"signals":{"items":{"type":"object"},"title":"Signals","type":"array"}},"required":["signals","scores","level1","level2_3"],"title":"FQOutput","type":"object"},"FQOutputLevel":{"description":"For Legacy, in the case of the level1 output, these fields will all be empty and in the case of level2_3, annualized_loss will be empty.","properties":{"annualized_loss":{"items":{"$ref":"#/components/schemas/FQOutputLoss"},"title":"Annualized Loss","type":"array"},"probabilities":{"items":{"$ref":"#/components/schemas/FQOutputProbability"},"title":"Probabilities","type":"array"},"single_loss":{"items":{"$ref":"#/components/schemas/FQOutputLoss"},"title":"Single Loss","type":"array"}},"required":["single_loss","annualized_loss","probabilities"],"title":"FQOutputLevel","type":"object"},"FQOutputLoss":{"description":"From model","properties":{"25th_exposure":{"title":"25Th Exposure","type":"number"},"50th_exposure":{"title":"50Th Exposure","type":"number"},"75th_exposure":{"title":"75Th Exposure","type":"number"},"average":{"title":"Average","type":"number"},"ep_curve":{"items":{"type":"number"},"title":"Ep Curve","type":"array"},"fq_scenario_name":{"$ref":"#/components/schemas/FqScenario"},"high_exposure":{"title":"High Exposure","type":"number"},"low_exposure":{"title":"Low Exposure","type":"number"},"maximum":{"title":"Maximum","type":"number"},"min":{"title":"Min","type":"number"}},"required":["fq_scenario_name","low_exposure","average","high_exposure","25th_exposure","50th_exposure","75th_exposure","min","maximum","ep_curve"],"title":"FQOutputLoss","type":"object"},"FQOutputProbability":{"description":"From model","properties":{"fq_scenario_name":{"$ref":"#/components/schemas/FqScenario"},"total_probability":{"title":"Total Probability","type":"number"}},"required":["fq_scenario_name","total_probability"],"title":"FQOutputProbability","type":"object"},"FQOutputResponse":{"description":"Summary of a financial quantification output","properties":{"completed_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Completed At","type":"string"},"created_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Created At","type":"string"},"fq_guid":{"format":"uuid","title":"Fq Guid","type":"string"},"guid":{"format":"uuid","title":"Guid","type":"string"},"run_time":{"format":"time-delta","title":"Run Time","type":"number"},"started_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Started At","type":"string"},"status":{"$ref":"#/components/schemas/FQOutputStatus"},"submitted_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Submitted At","type":"string"},"updated_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Updated At","type":"string"}},"required":["guid","fq_guid","status","created_at","updated_at"],"title":"FQOutputResponse","type":"object"},"FQOutputScores":{"description":"From model","properties":{"detection_or_response":{"title":"Detection Or Response","type":"number"},"fortitude_score":{"title":"Fortitude Score","type":"number"},"protection":{"title":"Protection","type":"number"}},"required":["detection_or_response","protection","fortitude_score"],"title":"FQOutputScores","type":"object"},"FQOutputStatus":{"description":"An enumeration.","enum":["draft","submitted","running","error","complete"],"title":"FQOutputStatus"},"FqDetailResponse":{"description":"Detail for a financial quantification","properties":{"company":{"$ref":"#/components/schemas/Company"},"completed_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Completed At","type":"string"},"created_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Created At","type":"string"},"created_by":{"format":"uuid","title":"Created By","type":"string"},"customer":{"$ref":"#/components/schemas/Customer"},"guid":{"format":"uuid","title":"Guid","type":"string"},"highlights":{"$ref":"#/components/schemas/FqOutputSummaryResponse"},"input_data":{"$ref":"#/components/schemas/FqInput"},"output_data":{"$ref":"#/components/schemas/FQOutput"},"status":{"$ref":"#/components/schemas/FqStatus"},"submitted_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Submitted At","type":"string"},"updated_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Updated At","type":"string"}},"required":["guid","status","created_at","updated_at","customer","company","created_by","input_data"],"title":"FqDetailResponse","type":"object"},"FqExposureResponse":{"properties":{"average":{"title":"Average","type":"number"},"maximum":{"title":"Maximum","type":"number"},"minimum":{"title":"Minimum","type":"number"}},"required":["minimum","average","maximum"],"title":"FqExposureResponse","type":"object"},"FqInput":{"description":"Input data for an FQ.","properties":{"questionnaire":{"$ref":"#/components/schemas/Questionnaire"}},"required":["questionnaire"],"title":"FqInput","type":"object"},"FqOutputSummaryResponse":{"description":"Highlights from an FQ","properties":{"overall_exposure":{"$ref":"#/components/schemas/FqExposureResponse"},"rating":{"title":"Rating,","type":"integer"}},"required":["rating","overall_exposure"],"title":"FqOutputSummaryResponse","type":"object"},"FqScenario":{"description":"The various loss scenarios.","enum":["Overall Exposure","Business Interruption","Data Theft & Privacy","Ransomware & Extortion","Regulation Compliance","3rd Party Service Provider Failure","Third Party Liability","Other Risk Scenario"],"title":"FqScenario"},"FqStatus":{"description":"An enumeration.","enum":["draft","submitted","error","complete"],"title":"FqStatus"},"FqSummaryResponse":{"description":"Summary of a financial quantification","properties":{"company":{"$ref":"#/components/schemas/Company"},"completed_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Completed At","type":"string"},"created_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Created At","type":"string"},"created_by":{"format":"uuid","title":"Created By","type":"string"},"customer":{"$ref":"#/components/schemas/Customer"},"guid":{"format":"uuid","title":"Guid","type":"string"},"highlights":{"$ref":"#/components/schemas/FqOutputSummaryResponse"},"status":{"$ref":"#/components/schemas/FqStatus"},"submitted_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Submitted At","type":"string"},"updated_at":{"example":"2024-04-01 12:34:56","format":"bitsight-date-time","title":"Updated At","type":"string"}},"required":["guid","status","created_at","updated_at","customer","company","created_by"],"title":"FqSummaryResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"Page_FqSummaryResponse_":{"properties":{"count":{"title":"Count","type":"integer"},"results":{"items":{"$ref":"#/components/schemas/FqSummaryResponse"},"title":"Results","type":"array"}},"required":["count","results"],"title":"Page[FqSummaryResponse]","type":"object"},"Portfolio":{"description":"A paginated set of companies in a user's portfolio","properties":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"description":"A list of portfolio companies","items":{"$ref":"#/components/schemas/PortfolioCompany"},"type":"array"},"summaries":{"description":"Summary metadata about the response.","properties":{"my-company":{"description":"The guid of My Company","format":"uuid","maxLength":36,"type":"string"}}}},"type":"object"},"PortfolioCompany":{"properties":{"added_date":{"description":"Date the organization was added","format":"date","type":"string"},"compliance_claim":{"$ref":"#/components/schemas/CompanyComplianceClaim"},"custom_id":{"description":"A customer provided custom id for the organization","nullable":true,"type":"string"},"display_url":{"description":"The full URL for the organization's Security Ratings page on Bitsight","nullable":true,"type":"string"},"guid":{"description":"GUID of the company","format":"uuid","maxLength":36,"type":"string"},"industry":{"$ref":"#/components/schemas/CompanyIndustry"},"life_cycle":{"$ref":"#/components/schemas/CompanyLifeCycle"},"logo":{"description":"URL that contains the organization's official logo","type":"string"},"name":{"description":"Full name of the organization","type":"string"},"network_size_v4":{"description":"The number of IPv4 addresses attributed to the organization","type":"integer"},"primary_domain":{"description":"Primary domain of the organization","type":"string"},"rating":{"description":"Latest rating on rating_date","nullable":true,"type":"integer"},"rating_date":{"description":"The date of the latest rating for this company","format":"date","nullable":true,"type":"string"},"relationship":{"$ref":"#/components/schemas/CompanyRelationship"},"shortname":{"description":"Name of the organization","type":"string"},"sparkline":{"description":"Rating sparkline URL","type":"string"},"sub_industry":{"$ref":"#/components/schemas/CompanySubIndustry"},"subscription_type":{"$ref":"#/components/schemas/CompanySubscriptionType"},"tier":{"description":"The guid of the tier that this company is in, or None of it is not in a tier","nullable":true,"type":"string"},"tier_name":{"description":"The name of the tier that this company is in, or None of it is not in a tier","nullable":true,"type":"string"},"tier_order":{"description":"The order of the tier that this company is in, or None of it is not in a tier","nullable":true,"type":"integer"},"type":{"description":"Type(s) of organization as classified by Bitsight","items":{"type":"string"},"type":"array"}},"type":"object"},"PortfolioSummaries":{"description":"A mapping of field to an array of filter values for that field. The\nordering of each array is arbitrary.","properties":{"countries":{"description":"All of the countries that appear in your portfolio","items":{"type":"string"},"type":"array"},"industries":{"description":"All of the industries that appear in your portfolio","items":{"type":"string"},"type":"array"},"infections":{"description":"All of the infections that appear in your portfolio","items":{"type":"string"},"type":"array"},"open_ports":{"description":"All of the open ports that appear in your portfolio","items":{"type":"string"},"type":"array"},"product_types":{"description":"All of the 4th party product types that appear in your portfolio","items":{"type":"string"},"type":"array"},"products":{"description":"All of the 4th party products that appear in your portfolio","items":{"type":"string"},"type":"array"},"providers":{"description":"All of the 4th party providers that appear in your portfolio","items":{"type":"string"},"type":"array"},"software":{"description":"All of the software names that appear in your portfolio","items":{"type":"string"},"type":"array"},"subscription_types":{"description":"All of the subscription types that appear in your portfolio","items":{"type":"string"},"type":"array"},"types":{"description":"All of the rating types that appear in your portfolio","items":{"type":"string"},"type":"array"},"vulnerabilities":{"description":"All of the vulnerabilities that appear in your portfolio","items":{"type":"string"},"type":"array"}},"type":"object"},"PreviousCyberIncident":{"properties":{"damage_type":{"$ref":"#/components/schemas/DamageType"},"details":{"title":"Details","type":"string"},"financial_loss":{"title":"Financial Loss","type":"integer"}},"title":"PreviousCyberIncident","type":"object"},"Questionnaire":{"description":"Optional fields to allow users to save partially completed draft questionnaires.","properties":{"annual_revenue":{"minimum":10000,"title":"Annual Revenue","type":"integer"},"controls":{"$ref":"#/components/schemas/SecurityCertificationsAndRegulations"},"country_codes":{"default":[],"items":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"$ref":"#/components/schemas/ThreeDigitCountryCode"}]},"title":"Country Codes","type":"array"},"currency":{"$ref":"#/components/schemas/Currency"},"currency_conversion_date":{"format":"date","title":"Currency Conversion Date","type":"string"},"cyber_insurance":{"$ref":"#/components/schemas/CyberInsurance"},"employee_count_bucket":{"$ref":"#/components/schemas/EmployeeCount"},"industries":{"default":[],"items":{"type":"string"},"title":"Industries","type":"array"},"naics":{"default":[],"items":{"type":"integer"},"title":"Naics","type":"array"},"other_record_count":{"minimum":0,"title":"Other Record Count","type":"integer"},"past_incidents":{"default":[],"items":{"$ref":"#/components/schemas/PreviousCyberIncident"},"title":"Past Incidents","type":"array"},"payment_card_industry_record_count":{"minimum":0,"title":"Payment Card Industry Record Count","type":"integer"},"personally_identifiable_info_record_count":{"minimum":0,"title":"Personally Identifiable Info Record Count","type":"integer"},"protected_health_info_record_count":{"minimum":0,"title":"Protected Health Info Record Count","type":"integer"},"states":{"default":[],"items":{"type":"string"},"title":"States","type":"array"}},"required":["controls","cyber_insurance"],"title":"Questionnaire","type":"object"},"Regulation":{"description":"An enumeration.","enum":["USFLR","USSLR","PCI","GDPR","OTHER"],"title":"Regulation","type":"string"},"SecurityCertificate":{"description":"An enumeration.","enum":["SOC","ISO","PCI_DSS","NIST_800","NIST_CSF"],"title":"SecurityCertificate","type":"string"},"SecurityCertificationsAndRegulations":{"properties":{"regulations":{"default":[],"items":{"$ref":"#/components/schemas/Regulation"},"type":"array"},"security_certificates":{"default":[],"items":{"$ref":"#/components/schemas/SecurityCertificate"},"type":"array"},"security_products":{"default":[],"items":{"$ref":"#/components/schemas/SecurityProducts"},"type":"array"}},"title":"SecurityCertificationsAndRegulations","type":"object"},"SecurityProducts":{"description":"An enumeration.","enum":["ICHA","ICSA","CVM","CUAP","SCHS","MMAAL","EWBP","MD","LCNPPS","DRC","SCND","BD","DP","CAB","WAC","AMC","ISA","ASS","IRM","PTRT"],"title":"SecurityProducts","type":"string"},"ThreeDigitCountryCode":{"description":"An enumeration.","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","ZAF","ZMB","ZWE"],"title":"ThreeDigitCountryCode"},"User":{"description":"A user","properties":{"email":{"description":"Email address","type":"string"},"email_preferences":{"description":"The email preferences settings for the user (only return for current user).","properties":{"compromised_system_alerts":{"description":"whether the user will receive event alert emails.","type":"boolean"},"notifications":{"description":"a list of the different notification types that the user will receive email for","properties":{"annotation":{"description":"Email alerts for comments that mentions the user.","type":"boolean"},"company_request":{"description":"company requests by the user or other users within the same company if admin","type":"boolean"},"folder":{"description":"when a folder has been shared with the user or deleted","type":"boolean"},"issue_tracking":{"description":"when a finding has been assigned to the user","type":"boolean"},"report":{"description":"when a pdf report download is ready","type":"boolean"}},"type":"object"},"real_time_alerts":{"description":"fields for if/when the user will receive real time alert emails","properties":{"alerts_period":{"description":"the frequency of which the user will receive the alert emails","type":"integer"},"is_enabled":{"description":"if the user will receive the email","type":"boolean"}},"type":"object"}},"type":"object"},"features":{"description":"User managed features","items":{"properties":{"can_update":{"description":"If the feature value can be updated for this user","readOnly":true,"type":"boolean"},"slug":{"description":"Feature slug","enum":["wfh-ro","fq-access"],"type":"string"},"value":{"description":"Feature value.","oneOf":[{"type":"boolean"},{"type":"string"}]}},"type":"object"},"type":"array"},"formal_name":{"description":"Formal name","type":"string"},"friendly_name":{"description":"Friendly name","type":"string"},"group":{"description":"Group that the user belongs to","properties":{"guid":{"description":"Group identifier","type":"string"},"name":{"description":"Group name","type":"string"}},"type":"object"},"guid":{"description":"GUID for this user","readOnly":true,"type":"string"},"is_available_for_contact":{"description":"Indicates if the user is set as a customer contact","type":"boolean"},"is_company_api_token":{"description":"Indicates if it is a token user","readOnly":true,"type":"boolean"},"joined_time":{"description":"Time the user was created","example":"2024-04-01 12:34:56","format":"bitsight-date-time","readOnly":true,"type":"string"},"landing_page":{"description":"User portal landing page","enum":["DEFAULT","SPM","TPRM"],"type":"string"},"last_login_time":{"description":"Last time the user logged in","example":"2024-04-01 12:34:56","format":"bitsight-date-time","readOnly":true,"type":"string"},"preferred_contact_for_entities":{"description":"List of entities of which the user is a preferred contact","items":{"description":"GUID of the company","format":"uuid","maxLength":36,"type":"string"},"type":"array"},"roles":{"description":"User roles","items":{"description":"User role","properties":{"name":{"description":"User role name","type":"string"},"slug":{"description":"User role identifier","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"User status","enum":["Created","Activated","Deactivated"],"readOnly":true,"type":"string"}},"type":"object"},"UserResponse":{"description":"A paginated set of users","properties":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"description":"A list of users","items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}},"securitySchemes":{"Jwt":{"in":"header","name":"Authorization","type":"apiKey"},"Token":{"scheme":"basic","type":"http"}}},"info":{"description":"`api.bitsighttech.com/v2` [requires API token](https://help.bitsighttech.com/hc/en-us/articles/231872628)\n","title":"Bitsight Customer API","version":"2.0.0"},"openapi":"3.0.0","paths":{"/alerts":{"get":{"description":"A list of paginated alerts","operationId":"AlertsList","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"Sort the alerts by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["guid","alert_type","alert_date","company_name","folder_name","trigger","severity"],"type":"string"}},{"description":"Filter alerts by the specified company guid.","in":"query","name":"company_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified folder guid.","in":"query","name":"folder_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified alert type.","in":"query","name":"alert_type","required":false,"schema":{"enum":["PERCENT_CHANGE","RATING_THRESHOLD","RISK_CATEGORY","NIST_CATEGORY","INFORMATIONAL","SERVICE_PROVIDER","VULNERABILITY","PUBLIC_DISCLOSURE","FP_PUBLIC_DISCLOSURE"],"type":"string"}},{"description":"Filter alerts by the specified severity level","in":"query","name":"severity","required":false,"schema":{"enum":["CRITICAL","WARN","INCREASE","INFORMATIONAL","CUSTOM"],"type":"string"}},{"description":"Comma seperated list of fields to expand. If expand=details is set, include additional alert details. If expand=custom_id is set, include company_custom_id in the response.","in":"query","name":"expand","required":false,"schema":{"enum":["details","custom_id"],"type":"string"}},{"description":"Filter alerts by the specified alert date.","in":"query","name":"alert_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being less than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being less than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lte","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being greater than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being greater than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gte","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter entities based on their subscription/folder scope","in":"query","name":"scope","required":false,"schema":{"enum":["spm"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"}}},"description":"List of paginated alerts"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Alerts"]}},"/alerts/customer":{"get":{"description":"A list of paginated customer-wide alerts","operationId":"CustomerAlertsList","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"Sort the alerts by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["guid","alert_type","alert_date","company_name","folder_name","trigger","severity"],"type":"string"}},{"description":"Filter alerts by the specified company guid.","in":"query","name":"company_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified folder guid.","in":"query","name":"folder_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified alert type.","in":"query","name":"alert_type","required":false,"schema":{"enum":["PERCENT_CHANGE","RATING_THRESHOLD","RISK_CATEGORY","NIST_CATEGORY","INFORMATIONAL","SERVICE_PROVIDER","VULNERABILITY","PUBLIC_DISCLOSURE"],"type":"string"}},{"description":"Filter alerts by the specified public_disclosure_category or null for non-public disclosure alerts.","in":"query","name":"public_disclosure_category","required":false,"schema":{"enum":["Breach Security Incident","General Security Incident","Other Disclosure"],"type":"string"}},{"description":"Filter alerts by the specified severity level","in":"query","name":"severity","required":false,"schema":{"enum":["CRITICAL","WARN","INCREASE","INFORMATIONAL","CUSTOM"],"type":"string"}},{"description":"If expand=details is set, include additional alert details","in":"query","name":"expand","required":false,"schema":{"enum":["details"],"type":"string"}},{"description":"Filter alerts by the specified alert date.","in":"query","name":"alert_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being less than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being less than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lte","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being greater than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being greater than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gte","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"}}},"description":"List of paginated customer-wide alerts."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Alerts"]}},"/alerts/latest":{"get":{"description":"List of the latest Alerts (according to the most recent date of alert generation)","operationId":"LatestAlertsList","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"Sort the alerts by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["guid","alert_type","alert_date","company_name","folder_name","trigger","severity"],"type":"string"}},{"description":"Filter alerts by the specified company guid.","in":"query","name":"company_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified folder guid.","in":"query","name":"folder_guid","required":false,"schema":{"type":"string"}},{"description":"Filter alerts by the specified alert type.","in":"query","name":"alert_type","required":false,"schema":{"enum":["PERCENT_CHANGE","RATING_THRESHOLD","RISK_CATEGORY","NIST_CATEGORY","INFORMATIONAL","SERVICE_PROVIDER","VULNERABILITY","PUBLIC_DISCLOSURE","FP_PUBLIC_DISCLOSURE"],"type":"string"}},{"description":"Filter alerts by the specified severity level","in":"query","name":"severity","required":false,"schema":{"enum":["CRITICAL","WARN","INCREASE","INFORMATIONAL","CUSTOM"],"type":"string"}},{"description":"Comma seperated list of fields to expand. If expand=details is set, include additional alert details. If expand=custom_id is set, include company_custom_id in the response.","in":"query","name":"expand","required":false,"schema":{"enum":["details","custom_id"],"type":"string"}},{"description":"Filter alerts by the specified alert date.","in":"query","name":"alert_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being less than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being less than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_lte","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with alert_date being greater than given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gt","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter alerts with last_seen being greater than or equal to the given value. This parameter is incompatible with 'alert_date'.","in":"query","name":"alert_date_gte","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter entities based on their subscription/folder scope","in":"query","name":"scope","required":false,"schema":{"enum":["spm"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"}}},"description":"List of paginated alerts"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Alerts"]}},"/alerts/{guid}/affected-companies":{"get":{"description":"List of companies that were indirectly affected by a 4th party breach.","operationId":"AffectedCompaniesList","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"numeric GUID of a 4th party public disclosure alert","in":"path","name":"guid","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffectedCompanies"}}},"description":"List of paginated companies"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Unprocessable"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Alerts"]}},"/companies/{company_guid}/financial-quantifications":{"get":{"description":"Get all financial quantifications for a company","operationId":"get_fqs_customer_api_v1_companies__company_guid__financial_quantifications_get","parameters":[{"in":"path","name":"company_guid","required":true,"schema":{"format":"uuid","title":"Company Guid","type":"string"}},{"in":"query","name":"created_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Lt","type":"string"}},{"in":"query","name":"created_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Lte","type":"string"}},{"in":"query","name":"created_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Gt","type":"string"}},{"in":"query","name":"created_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Gte","type":"string"}},{"in":"query","name":"updated_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Lt","type":"string"}},{"in":"query","name":"updated_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Lte","type":"string"}},{"in":"query","name":"updated_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Gt","type":"string"}},{"in":"query","name":"updated_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Gte","type":"string"}},{"in":"query","name":"submitted_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Lt","type":"string"}},{"in":"query","name":"submitted_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Lte","type":"string"}},{"in":"query","name":"submitted_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Gt","type":"string"}},{"in":"query","name":"submitted_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Gte","type":"string"}},{"in":"query","name":"completed_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Lt","type":"string"}},{"in":"query","name":"completed_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Lte","type":"string"}},{"in":"query","name":"completed_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Gt","type":"string"}},{"in":"query","name":"completed_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Gte","type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"title":"Sort","type":"string"}},{"in":"query","name":"is_legacy","required":false,"schema":{"title":"Is Legacy","type":"boolean"}},{"in":"query","name":"status","required":false,"schema":{"title":"Status","type":"string"}},{"in":"query","name":"status__ne","required":false,"schema":{"title":"Status Ne","type":"string"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"title":"Offset","type":"integer"}},{"in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":100,"minimum":0,"title":"Limit","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_FqSummaryResponse_"}}},"description":"Successful Response,"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error,"}},"summary":"Get Fqs","tags":["Financial Quantification"]},"post":{"description":"Creates a draft FQ unless submit=true is specified","operationId":"create_fq_for_company_customer_api_v1_companies__company_guid__financial_quantifications_post","parameters":[{"in":"path","name":"company_guid","required":true,"schema":{"format":"uuid","title":"Company Guid","type":"string"}},{"in":"query","name":"submit","required":false,"schema":{"default":false,"title":"Submit","type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response for Draft"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response for Submission"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error,"}},"summary":"Create Fq For Company","tags":["Financial Quantification"]}},"/companies/{company_guid}/financial-quantifications/latest":{"get":{"description":"Get the most recent FQ for a company (by update date)","operationId":"get_latest_fq_customer_api_v1_companies__company_guid__financial_quantifications_latest_get","parameters":[{"in":"path","name":"company_guid","required":true,"schema":{"format":"uuid","title":"Company Guid","type":"string"}},{"in":"query","name":"created_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Lt","type":"string"}},{"in":"query","name":"created_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Lte","type":"string"}},{"in":"query","name":"created_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Gt","type":"string"}},{"in":"query","name":"created_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Created At Gte","type":"string"}},{"in":"query","name":"updated_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Lt","type":"string"}},{"in":"query","name":"updated_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Lte","type":"string"}},{"in":"query","name":"updated_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Gt","type":"string"}},{"in":"query","name":"updated_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Updated At Gte","type":"string"}},{"in":"query","name":"submitted_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Lt","type":"string"}},{"in":"query","name":"submitted_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Lte","type":"string"}},{"in":"query","name":"submitted_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Gt","type":"string"}},{"in":"query","name":"submitted_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Submitted At Gte","type":"string"}},{"in":"query","name":"completed_at__lt","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Lt","type":"string"}},{"in":"query","name":"completed_at__lte","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Lte","type":"string"}},{"in":"query","name":"completed_at__gt","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Gt","type":"string"}},{"in":"query","name":"completed_at__gte","required":false,"schema":{"format":"bitsight-date-time","title":"Completed At Gte","type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"title":"Sort","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"title":"Status","type":"string"}},{"in":"query","name":"status__ne","required":false,"schema":{"title":"Status Ne","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response,"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error,"}},"summary":"Get Latest Fq","tags":["Financial Quantification"]}},"/companies/{company_guid}/financial-quantifications/{fq_guid}":{"get":{"description":"Get a specific FQ for a company","operationId":"get_fq_customer_api_v1_companies__company_guid__financial_quantifications__fq_guid__get","parameters":[{"in":"path","name":"company_guid","required":true,"schema":{"format":"uuid","title":"Company Guid","type":"string"}},{"in":"path","name":"fq_guid","required":true,"schema":{"format":"uuid","title":"Fq Guid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response,"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error,"}},"summary":"Get Fq","tags":["Financial Quantification"]},"put":{"description":"Updates a draft FQ (submit=true will also submit it)","operationId":"update_fq_customer_api_v1_companies__company_guid__financial_quantifications__fq_guid__put","parameters":[{"in":"path","name":"company_guid","required":true,"schema":{"format":"uuid","title":"Company Guid","type":"string"}},{"in":"path","name":"fq_guid","required":true,"schema":{"format":"uuid","title":"Fq Guid","type":"string"}},{"in":"query","name":"submit","required":false,"schema":{"default":false,"title":"Submit","type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response for Draft"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FqDetailResponse"}}},"description":"Successful Response for Submission"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Update Fq","tags":["Financial Quantification"]}},"/company-requests":{"get":{"description":"Lists company requests","operationId":"getCompanyRequests","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"Sort the company requests by the specified parameters, separated by a comma. '-' can be used to prefix a parameter to invert the order.\n","in":"query","name":"sort","required":false,"schema":{"enum":["created_time","updated_time","domain","requester.formal_name"],"type":"string"}},{"description":"Filter by matching domains","in":"query","name":"domain","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more specific statuses, comma separated","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Filter by a specific company guid","in":"query","name":"company.guid","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more specific requesters, by name, comma separated","in":"query","name":"requester.formal_name","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more specific requesters, by guid, comma separated. Supports 'current' alias for selecting the current user.\n","in":"query","name":"requester.guid","required":false,"schema":{"type":"string"}},{"description":"Excludes one or more specific requesters, by guid, comma separated. Supports 'current' alias for selecting the current user.\n","in":"query","name":"exclude_requester.guid","required":false,"schema":{"type":"string"}},{"description":"Filter by requests created after or at the provided ISO 8601 datetime.","in":"query","name":"created_time_gte","required":false,"schema":{"format":"bitsight-date-time","type":"string"}},{"description":"Filter by requests created before or at the provided ISO 8601 datetime.","in":"query","name":"created_time_lte","required":false,"schema":{"format":"bitsight-date-time","type":"string"}},{"description":"Filter by requests updated after or at the provided ISO 8601 datetime.","in":"query","name":"updated_time_gte","required":false,"schema":{"format":"bitsight-date-time","type":"string"}},{"description":"Filter by requests updated before or at the provided ISO 8601 datetime.","in":"query","name":"updated_time_lte","required":false,"schema":{"format":"bitsight-date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CompanyRequestsResponse"},"type":"array"}}},"description":"OK"},"400":{"description":"There is an error in your request"},"401":{"description":"Not Authorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"You do not have sufficient privileges in the system to perform this request\n"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Company Requests"]},"post":{"description":"Requests a company, not yet on Bitsight company inventory","operationId":"createCompanyRequest","requestBody":{"content":{"application/json":{"schema":{"properties":{"company_request":{"$ref":"#/components/schemas/CompanyRequest"}},"required":["company_request"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"}}},"description":"Company request submitted successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"$ref":"#/components/schemas/CompanyRequest"},"domain":{"items":{"example":"A pending request for the given domain already exists.","type":"string"},"type":"array"}},"type":"object"}}},"description":"There is already a pending request for this company submitted by you."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Company Requests"]}},"/company-requests/bulk":{"post":{"description":"Manage the bulk creation of company requests from a given CSV.","operationId":"createCompanyRequestBulk","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Csv file containing bulk company requests.","type":"string"},"folder_guid":{"description":"Folder guid","type":"string"},"subscription_type":{"description":"Subscription type","type":"string"},"tier_guid":{"description":"Tier guid","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"}}},"description":"Company request submitted successfully"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Company Requests"]}},"/company-requests/{guid}":{"delete":{"description":"Cancel a submitted company request","operationId":"deleteCompanyRequest","parameters":[{"description":"Company request guid","in":"path","name":"guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"204":{"description":"The company request was successfully cancelled"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Company Requests"]},"get":{"description":"Get detailed information about a company request","operationId":"getCompanyRequest","parameters":[{"description":"Company request guid","in":"path","name":"guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"}}},"description":"OK"}},"tags":["Company Requests"]},"patch":{"description":"Edit a company request","operationId":"editCompanyRequest","parameters":[{"description":"Company request guid","in":"path","name":"guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"company_request":{"$ref":"#/components/schemas/CompanyRequest","description":"The details of the company request to modify."}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRequest"}}},"description":"Company request modified successfully"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Company Requests"]}},"/portfolio":{"get":{"description":"A list of paginated portfolio companies","operationId":"PortfolioList","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/FormatIncludeCSV"},{"description":"Filter companies by excluding one or more subscription type slugs, e.g. 'continuous_monitoring,alerts-only'","in":"query","name":"exclude_subscription_type.slug","required":false,"schema":{"type":"string"}},{"description":"Comma delimited list of fields to return in each result","in":"query","name":"fields","required":false,"schema":{"enum":["rating","industry.name","rating_date","life_cycle.name","relationship.slug","logo","subscription_type.slug","network_size_v4","guid","sparkline","primary_domain","sub_industry.slug","shortname","industry.slug","relationship.name","subscription_type.name","added_date","life_cycle.slug","tier","sub_industry.name","custom_id","name","display_url","type"],"type":"string"}},{"description":"A list of fields for which you want to group filters. Grouping\nis only supported for certain fields, and modifies the way that the\nfilters intersect with each other.","in":"query","name":"filter_group","required":false,"schema":{"enum":["risk_vectors","software"],"type":"string"}},{"description":"Filter companies by one or more folder guids, or null to include companies that are in no visible folders.","in":"query","name":"folder","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more industry name, e.g. 'Finance,Technology'","in":"query","name":"industry.name","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more industry slugs, e.g. 'finance,technology'","in":"query","name":"industry.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more infection names, e.g. 'Zloader,Conficker'","in":"query","name":"infections","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more life cycle slugs or null to include companies with no life cycle assigned, e.g. 'onboarding,null'","in":"query","name":"life_cycle.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more open ports, e.g. 'SIP,Port 8081'","in":"query","name":"open_ports","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more rating types, e.g. 'CURATED,SELF-PUBLISHED'","in":"query","name":"type","required":false,"schema":{"enum":["CURATED","PROVISIONAL","SELF-PUBLISHED","PRIVATE","COUNTRY"],"type":"string"}},{"description":"Filter companies by a list of guids.","in":"query","name":"guid","required":false,"schema":{"type":"string"}},{"description":"Filter companies by a single rating value.","in":"query","name":"rating","required":false,"schema":{"format":"integer","type":"string"}},{"description":"Filter companies with rating less than the given value.","in":"query","name":"rating_lt","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating less than or equal to the given value.","in":"query","name":"rating_lte","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating greater than the given value.","in":"query","name":"rating_gt","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating greater than or equal to the given value.","in":"query","name":"rating_gte","required":false,"schema":{"format":"integer","type":"string"}},{"description":"Filter companies by one or more relationship slugs or null to include companies with no relationship assigned, e.g. 'vendor,null'","in":"query","name":"relationship.slug","required":false,"schema":{"type":"string"}},{"description":"Sort companies by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["name","rating","industry.name","life_cycle.name","relationship.name","subscription_type.name","tier"],"type":"string"}},{"description":"Filter companies by one or more subscription type slugs, e.g. 'continuous_monitoring,alerts-only'","in":"query","name":"subscription_type.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more tier guids, or null to include companies that are in no visible tier.","in":"query","name":"tier","required":false,"schema":{"type":"string"}},{"description":"Filter companies by partial name match.","in":"query","name":"name_q","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more vendor action plans, e.g. 'escalate,monitor'","in":"query","name":"vendor_action_plan","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more vulnerabilities, e.g. 'POODLE'","in":"query","name":"vulnerabilities","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more countries in which they have IPs, e.g. 'US,CA'.\nUse 'EUU' for all EU countries and 'NEU' for all non-EU countries.","in":"query","name":"countries","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more regions in which they have IPs, e.g. 'US-MA,ES-CT'.","in":"query","name":"regions","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more categories of security incidents which occured for the company or its subsidiaries in the past year. e.g. \"general,breach\"","in":"query","name":"security_incident_categories","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which risk vectors they have grades for. On its\nown, this includes companies which have any grade (A-F) in any one\nof the specified risk vectors. This can be intersected with\n`risk_vectors.grade` by using `filter_group=risk_vectors` to filter\nby specific grades in specific risk vectors.","in":"query","name":"risk_vectors.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which grades they have in any risk vector. On\nits own, this includes companies which have any of the specified\ngrades in any risk vector. This can be intersected with\n`risk_vectors.slug` by using `filter_group=risk_vectors` to filter\nby specific grades in specific risk vectors.","in":"query","name":"risk_vectors.grade","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which categories of software (Supported,\nUnsupported, Unknown) they have. On its own, this includes companies\nwhich have at least one software if any of the specified categories.\nThis can be intersected with `software.name` by using `filter_group=software`\nto filter by specific software in specific categories.","in":"query","name":"software.category","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which software has been detected on their network.\nOn its own, this includes companies which have any of the specified\nsoftware, across all software categories. This can be intersected\nwith `software.category` by using `filter_group=software` to filter\nby specific software in specific categories.","in":"query","name":"software.name","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party service provider relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"providers","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party product relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"products","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party product type relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"product_types","required":false,"schema":{"type":"string"}},{"description":"Filter companies by relationship type, the only known scope now is SPM, which is\nthe set of companies with a Subsidiary Subscription Type + Your own company","in":"query","name":"scope","required":false,"schema":{"enum":["spm"],"type":"string"}},{"description":"Exclude subscriptions-types","example":"continuous_monitoring, alerts_only","in":"query","name":"exclude_subscription_type","required":false,"schema":{"type":"string"}},{"description":"Show only organizations whose IPs are visible","in":"query","name":"show_ips","required":false,"schema":{"type":"boolean"}},{"description":"Show only organizations that have enhanced event evidence enabled","in":"query","name":"show_event_evidence","required":false,"schema":{"type":"boolean"}},{"description":"Filter organizations based on whether or not they are self-published","in":"query","name":"is_self_published","required":false,"schema":{"enum":["true","false"],"type":"string"}},{"description":"Filter organizations by one or more visibility types, e.g. 'PRIMARY,PRIVATE'","in":"query","name":"visibility","required":false,"schema":{"enum":["PRIMARY","PRIVATE"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}},"description":"List of paginated portfolio companies."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Portfolio"]},"post":{"description":"A list of paginated portfolio companies","operationId":"PortfolioListPost","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/FormatIncludeCSV"},{"description":"Filter companies by excluding one or more subscription type slugs, e.g. 'continuous_monitoring,alerts-only'","in":"query","name":"exclude_subscription_type.slug","required":false,"schema":{"type":"string"}},{"description":"Comma delimited list of fields to return in each result","in":"query","name":"fields","required":false,"schema":{"enum":["rating","industry.name","rating_date","life_cycle.name","relationship.slug","logo","subscription_type.slug","network_size_v4","guid","sparkline","primary_domain","sub_industry.slug","shortname","industry.slug","relationship.name","subscription_type.name","added_date","life_cycle.slug","tier","sub_industry.name","custom_id","name","display_url","type"],"type":"string"}},{"description":"A list of fields for which you want to group filters. Grouping\nis only supported for certain fields, and modifies the way that the\nfilters intersect with each other.","in":"query","name":"filter_group","required":false,"schema":{"enum":["risk_vectors","software"],"type":"string"}},{"description":"Filter companies by one or more folder guids, or null to include companies that are in no visible folders.","in":"query","name":"folder","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more industry name, e.g. 'Finance,Technology'","in":"query","name":"industry.name","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more industry slugs, e.g. 'finance,technology'","in":"query","name":"industry.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more infection names, e.g. 'Zloader,Conficker'","in":"query","name":"infections","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more life cycle slugs or null to include companies with no life cycle assigned, e.g. 'onboarding,null'","in":"query","name":"life_cycle.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more open ports, e.g. 'SIP,Port 8081'","in":"query","name":"open_ports","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more rating types, e.g. 'CURATED,SELF-PUBLISHED'","in":"query","name":"type","required":false,"schema":{"enum":["CURATED","PROVISIONAL","SELF-PUBLISHED","PRIVATE","COUNTRY"],"type":"string"}},{"description":"Filter companies by a list of guids.","in":"query","name":"guid","required":false,"schema":{"type":"string"}},{"description":"Filter companies by a single rating value.","in":"query","name":"rating","required":false,"schema":{"format":"integer","type":"string"}},{"description":"Filter companies with rating less than the given value.","in":"query","name":"rating_lt","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating less than or equal to the given value.","in":"query","name":"rating_lte","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating greater than the given value.","in":"query","name":"rating_gt","required":false,"schema":{"format":"integer","type":"string"}},{"description":"filter companies with rating greater than or equal to the given value.","in":"query","name":"rating_gte","required":false,"schema":{"format":"integer","type":"string"}},{"description":"Filter companies by one or more relationship slugs or null to include companies with no relationship assigned, e.g. 'vendor,null'","in":"query","name":"relationship.slug","required":false,"schema":{"type":"string"}},{"description":"Sort companies by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["name","rating","industry.name","life_cycle.name","relationship.name","subscription_type.name","tier"],"type":"string"}},{"description":"Filter companies by one or more subscription type slugs, e.g. 'continuous_monitoring,alerts-only'","in":"query","name":"subscription_type.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more tier guids, or null to include companies that are in no visible tier.","in":"query","name":"tier","required":false,"schema":{"type":"string"}},{"description":"Filter companies by partial name match.","in":"query","name":"name_q","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more vendor action plans, e.g. 'escalate,monitor'","in":"query","name":"vendor_action_plan","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more vulnerabilities, e.g. 'POODLE'","in":"query","name":"vulnerabilities","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more countries in which they have IPs, e.g. 'US,CA'.\nUse 'EUU' for all EU countries and 'NEU' for all non-EU countries.","in":"query","name":"countries","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more regions in which they have IPs, e.g. 'US-MA,ES-CT'.","in":"query","name":"regions","required":false,"schema":{"type":"string"}},{"description":"Filter companies by one or more categories of security incidents which occured for the company or its subsidiaries in the past year. e.g. \"general,breach\"","in":"query","name":"security_incident_categories","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which risk vectors they have grades for. On its\nown, this includes companies which have any grade (A-F) in any one\nof the specified risk vectors. This can be intersected with\n`risk_vectors.grade` by using `filter_group=risk_vectors` to filter\nby specific grades in specific risk vectors.","in":"query","name":"risk_vectors.slug","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which grades they have in any risk vector. On\nits own, this includes companies which have any of the specified\ngrades in any risk vector. This can be intersected with\n`risk_vectors.slug` by using `filter_group=risk_vectors` to filter\nby specific grades in specific risk vectors.","in":"query","name":"risk_vectors.grade","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which categories of software (Supported,\nUnsupported, Unknown) they have. On its own, this includes companies\nwhich have at least one software if any of the specified categories.\nThis can be intersected with `software.name` by using `filter_group=software`\nto filter by specific software in specific categories.","in":"query","name":"software.category","required":false,"schema":{"type":"string"}},{"description":"Filter companies by which software has been detected on their network.\nOn its own, this includes companies which have any of the specified\nsoftware, across all software categories. This can be intersected\nwith `software.category` by using `filter_group=software` to filter\nby specific software in specific categories.","in":"query","name":"software.name","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party service provider relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"providers","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party product relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"products","required":false,"schema":{"type":"string"}},{"description":"Filter companies by their fourth party product type relationships\nidentified either by Bitsight data sources or managed by the customer.","in":"query","name":"product_types","required":false,"schema":{"type":"string"}},{"description":"Filter companies by relationship type, the only known scope now is SPM, which is\nthe set of companies with a Subsidiary Subscription Type + Your own company","in":"query","name":"scope","required":false,"schema":{"enum":["spm"],"type":"string"}},{"description":"Exclude subscriptions-types","example":"continuous_monitoring, alerts_only","in":"query","name":"exclude_subscription_type","required":false,"schema":{"type":"string"}},{"description":"Show only organizations whose IPs are visible","in":"query","name":"show_ips","required":false,"schema":{"type":"boolean"}},{"description":"Show only organizations that have enhanced event evidence enabled","in":"query","name":"show_event_evidence","required":false,"schema":{"type":"boolean"}},{"description":"Filter organizations based on whether or not they are self-published","in":"query","name":"is_self_published","required":false,"schema":{"enum":["true","false"],"type":"string"}},{"description":"Filter organizations by one or more visibility types, e.g. 'PRIMARY,PRIVATE'","in":"query","name":"visibility","required":false,"schema":{"enum":["PRIMARY","PRIVATE"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}},"description":"List of paginated portfolio companies."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Portfolio"]}},"/portfolio/summaries":{"get":{"description":"Summarized filter data for the /portfolio endpoint. Used to populate all possible values for a number of filters on that endpoint.","operationId":"PortfolioSummaries","parameters":[{"description":"Comma delimited list of fields to return. If not passed, all fields are returned.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Only show results for the single given folder guid","in":"query","name":"folder","required":false,"schema":{"type":"string"}},{"description":"Only show results for the single given tier guid","in":"query","name":"tier","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioSummaries"}}},"description":"Dictionary of filter values, by field."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"}},"security":[{"Jwt":[]},{"Token":[]}],"tags":["Portfolio"]}},"/users":{"get":{"description":"Get information about users for your customer.","operationId":"getUsers","parameters":[{"$ref":"#/components/parameters/Query"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"description":"Sort the users by the specified parameters, separated by a comma. \u2018-\u2019 can be used to prefix a parameter to invert the order.","in":"query","name":"sort","required":false,"schema":{"enum":["formal_name","last_login_time","guid","email","group.name","status","joined_time"],"type":"string"}},{"description":"Filter by a specific user GUIDs, comma separated","in":"query","name":"guid","required":false,"schema":{"type":"string"}},{"description":"Filter by email","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Search by formal name","in":"query","name":"formal_name_q","required":false,"schema":{"type":"string"}},{"description":"Search by email","in":"query","name":"email_q","required":false,"schema":{"type":"string"}},{"description":"Filter by one or statuses, comma separated","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more role slugs, comma separated","in":"query","name":"roles.slug","required":false,"schema":{"enum":["customer_user","customer_portfolio_manager","customer_group_admin","customer_admin","vrm_admin","vrm_operations","vrm_view_only","vrm_internal_business_user","vulnerability_response_outreach"],"type":"string"}},{"description":"Filter by one or more group ids, comma separated","in":"query","name":"group.guid","required":false,"schema":{"type":"string"}},{"description":"Include or exclude company token users","in":"query","name":"is_company_api_token","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Include or exclude company users set as contact","in":"query","name":"is_available_for_contact","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Include or exclude users set as preferred contact","in":"query","name":"is_preferred_contact","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array"}}},"description":"OK"},"401":{"description":"Not Authorized"}},"tags":["Users"]},"post":{"description":"Create a user","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"properties":{"user":{"$ref":"#/components/schemas/User","description":"The details of the user to create."}},"type":"object"}}},"required":true},"responses":{"201":{"description":"User created successfully"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Users"]}},"/users/current":{"get":{"description":"Get detailed information about the current requesting User Profile","operationId":"getCurrentUser","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"object"}}},"description":"OK"}},"tags":["Users"]},"patch":{"description":"Edit the current user","operationId":"editCurrentUser","requestBody":{"content":{"application/json":{"schema":{"properties":{"user":{"$ref":"#/components/schemas/User","description":"The details of the user to modify."}},"type":"object"}}},"required":true},"responses":{"200":{"description":"User modified successfully"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Users"]}},"/users/query":{"post":{"description":"Post endpoint to list information about users for your customer.","operationId":"getUsersQuery","requestBody":{"content":{"application/json":{"schema":{"properties":{"guid":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array"}}},"description":"OK"},"401":{"description":"Not Authorized"}},"tags":["Users"]}},"/users/{user_guid}":{"delete":{"description":"Delete a user profile","operationId":"deleteUser","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"204":{"description":"The user profile was successfully deleted"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Users"]},"get":{"description":"Get detailed information about a user profile","operationId":"getUser","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"object"}}},"description":"OK"}},"tags":["Users"]},"patch":{"description":"Edit a user","operationId":"editUser","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"user":{"$ref":"#/components/schemas/User","description":"The details of the user to modify."}},"type":"object"}}},"required":true},"responses":{"200":{"description":"User modified successfully"},"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"tags":["Users"]}},"/users/{user_guid}/require-mfa":{"post":{"description":"Require MFA for this user","operationId":"requireMfa","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"The user already has MFA enabled"}},"tags":["Users"]}},"/users/{user_guid}/resend-activation-email":{"post":{"description":"(Re)send an activation email to the user","operationId":"resendUserActivation","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"The user has already been activated and cannot be sent another activation email"}},"tags":["Users"]}},"/users/{user_guid}/reset-mfa":{"post":{"description":"Reset MFA for this user","operationId":"resetMfa","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"The user already has MFA disabled"}},"tags":["Users"]}},"/users/{user_guid}/reset-pending-mfa":{"post":{"description":"Reset pending MFA for this user","operationId":"resetPendingMfa","parameters":[{"description":"User guid","in":"path","name":"user_guid","required":true,"schema":{"format":"uuid","maxLength":36,"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"The user already has MFA disabled"}},"tags":["Users"]}}},"security":[{"Jwt":[]},{"Token":[]}],"servers":[{"description":"production server","url":"https://api.bitsighttech.com/v2"},{"description":"testing server","url":"/customer-api/v2"}],"tags":[{"name":"Alerts"},{"name":"Users"}],"x-common-definitions":{"company_guid":{"description":"GUID of the company","format":"uuid","maxLength":36,"type":"string"},"default_read_errors":{"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"default_write_errors":{"400":{"$ref":"#/components/responses/BadData"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PermissionDenied"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Unexpected error"}},"folder_guid":{"description":"GUID of the folder","format":"uuid","maxLength":36,"type":"string"},"grade":{"enum":["NEUTRAL","BAD","WARN","FAIR","GOOD","NONE"],"type":"string"},"guid":{"format":"uuid","maxLength":36,"type":"string"},"paginated_result":{"count":{"description":"The total number of results","type":"integer"},"links":{"description":"A set of links to traverse the result set","properties":{"next":{"nullable":true,"type":"string"},"previous":{"nullable":true,"type":"string"}},"type":"object"},"results":{"description":"The actual results page","type":"array"}},"risk_category":{"enum":["Compromised Systems","Diligence","User Behavior"],"type":"string"},"tier_guid":{"description":"GUID of the tier","format":"uuid","maxLength":36,"type":"string"}}}