generated: '2026-10-14' method: derived generator: derive-data-model.py source: - openapi/security-scorecard-all-companies-vsor-customer-api-openapi-2-0-openapi.yml - openapi/security-scorecard-asi-internal-service-openapi.yml - openapi/security-scorecard-multiscores-api-openapi.yml - openapi/security-scorecard-securityscorecard-api-openapi.yml - openapi/security-scorecard-securityscorecard-openapi.yml notation: has_one = property $ref; has_many = array of $ref; belongs_to = _id field summary: entities: 211 entities_in_spec: 211 relationships: 10 entities: - name: ActionPlanList fields: 3 - name: ActionPlansList fields: 4 - name: AddCompaniesBulk fields: 4 - name: AddCompaniesBulkResponse fields: 9 - name: AddGuestsToActionPlan fields: 1 description: list of guests (user emails) that can access to the plan - name: AddVendorDomainsResult fields: 6 description: Vendor risk profiles for uploaded domains - name: AllCompaniesBulkDeleteResponse fields: 1 - name: AllCompaniesBulkUpdate fields: 0 - name: AllCompaniesBulkUpdateResponse fields: 1 - name: AllCompaniesResponse fields: 4 - name: AllIpsFromParentDomainResponseSchema fields: 2 - name: ArchiveActionPlansRequest fields: 1 description: List of action plan ids to archive - name: BadRequest fields: 0 - name: BreachesList fields: 4 - name: BulkDeleteScorecardTagsRequest fields: 2 description: ids of tags - name: BulkSearchResultsSchema fields: 5 description: bulk searches results - name: CollectionResponse fields: 3 - name: CompaniesInScorecardTag fields: 2 - name: CompanyActiveIssuesResponseSchema fields: 2 - name: CompanyByDomainResponse fields: 18 - name: CompanyFactors fields: 2 - name: CompanyHistoricalBreachesEventsSchema fields: 1 - name: CompanyHistoricalEventsSchema fields: 1 - name: CompanyHistoricalScoresSchema fields: 1 - name: CompanySummary fields: 17 - name: CreateCustomerUpdate fields: 4 description: settings and attachments for the customer update - name: CreateCustomerUpdateSchema fields: 1 - name: CreateManagementRequest fields: 4 description: request to add a managed customer - name: CreateManagementRequestSchema fields: 1 - name: CreateReportComplianceCsvExport fields: 3 description: report creation parameters - name: CreateReportDetailed fields: 2 description: Schema for filters, sorting, pagination, and related properties - name: CreateReportEventJson fields: 2 description: Schema for filters, sorting, pagination, and related properties - name: CreateReportFootprintDomains fields: 2 description: report creation parameters - name: CreateReportFootprintIps fields: 2 description: report creation parameters - name: CreateReportIssues fields: 2 description: report creation parameters - name: CreateReportPartnership fields: 1 description: report creation parameters - name: CreateReportScorecardFootprintDetailed fields: 5 description: Schema for filters, sorting, pagination, and related properties - name: CreateReportSummary fields: 2 description: report creation parameters - name: CreateVendorUpdate fields: 5 description: Settings for creating a new vendor update, including metadata fields required for submission - name: CreateVendorUpdateSchema fields: 1 - name: CustomerAccess fields: 3 - name: CustomerUpdatesList fields: 2 - name: CustomerVendorsTrends fields: 5 description: Vendor risk profiles for uploaded domains - name: CustomersByVendorSchema fields: 1 description: List of customers associated with a vendor that is part of a managed portfolio - name: DeleteCustomerUpdatesRequest fields: 1 description: Array of customer update ids to remove - name: DeleteGuestsFromActionPlan fields: 1 description: list of guests (user emails) that will be deleted from the plan - name: DeleteItemsFromActionPlan fields: 1 description: items to delete from the action plan - name: DeleteReportsBulkSchema fields: 1 - name: DeleteVendorUpdatesRequest fields: 1 description: Array of vendor update ids to remove - name: DocumentIdSchema fields: 1 description: Unique ID of the document - name: DocumentToUpdateSchema fields: 4 description: Document - name: DocumentToUploadSchema fields: 4 description: Document to upload. - name: DocumentUrlSchema fields: 1 - name: DocumentsListSchema fields: 2 - name: DocumentsToDeleteSchema fields: 1 description: Document ids to delete. - name: DomainAssetsResponseSchema fields: 2 description: Schema for domain assets and associated metadata - name: DomainsFiltersSchema fields: 4 description: Schema for filters, sorting, pagination, and related properties - name: EmptyEntriesPaginationSchema fields: 3 description: Empty entries array - name: EmptyEntriesSizeSchema fields: 2 description: Empty entries array - name: EmptyEntriesWithTotalSchema fields: 2 description: Empty entries array - name: Error fields: 4 - name: ErrorBadRequest fields: 1 - name: ErrorForbidden fields: 1 - name: ErrorLevelData fields: 1 - name: ErrorNotFound fields: 1 - name: ErrorRateLimit fields: 1 - name: ErrorResponse fields: 1 - name: ErrorUnauthorized fields: 1 - name: ExpandedRiskSchema fields: 3 - name: FactorScoresByIndustrySchema fields: 1 - name: FactorsResponseSchema fields: 1 - name: FiltersAndPaginationSchema fields: 4 - name: FindingsList fields: 4 - name: Forbidden fields: 0 - name: GetPortfolioCompanies fields: 2 - name: GetPortfolioCompaniesV2 fields: 4 - name: HistoricalFactorScoresByCompanySchema fields: 1 - name: HistoricalFactorScoresByIndustrySchema fields: 1 - name: HistoricalScoreByIndustrySchema fields: 1 - name: ImproveFactorScoreActionPlan fields: 7 description: action plan to create - name: ImproveOverallScoreActionPlan fields: 6 description: action plan to create - name: IndicatorExclusionList fields: 4 - name: IndicatorsList fields: 4 - name: InternalServerError fields: 0 - name: InvitationReponseSchema fields: 1 - name: IpDomainTagGroupPayload fields: 2 description: ip domain tag group payload - name: IpDomainTagGroupRequest fields: 2 description: ip domain tag group payload - name: IpDomainTagGroupResponse fields: 5 description: Ip Domain Tag Group - name: IpDomainTagRequest fields: 2 description: ip domain tag payload - name: IpDomainsTagGroupsResponse fields: 1 description: Get all ip domain tag groups - name: IpTagRequest fields: 2 description: ip domain tag payload - name: IpTagResponse fields: 6 description: a tag - name: IssueContext fields: 2 - name: IssueResolutionActionPlan fields: 6 description: action plan to create - name: LikelihoodAssessmentBulkPartnerLogs fields: 2 - name: LikelihoodAssessmentBulkPostRequest fields: 3 - name: LikelihoodAssessmentV2GetResponse fields: 0 - name: LikelihoodAssessmentV2PostResponse fields: 4 - name: ManagedCustomerSchema fields: 6 description: Managed customer details - name: ManagedCustomerVendor fields: 16 description: Managed customer vendor details - name: ManagedCustomersList fields: 2 - name: ManagedPortfoliosSchema fields: 1 description: List of managed portfolios associated with the specified customer ID - name: MessageResponseSchema fields: 1 - name: MetadataIssueTypeDetailedResponseSchema fields: 7 - name: MetadataIssueTypeResponseSchema fields: 1 - name: Multiscore fields: 5 - name: MultiscoreEntry fields: 6 - name: MultiscorePaginatedResponse fields: 4 - name: NegotiateVendorListFileRequest fields: 1 description: settings and attachments for the vendor update - name: NegotiateVendorListRequest fields: 2 description: settings and attachments for the vendor update - name: NotFound fields: 0 - name: Note fields: 6 - name: Portfolio fields: 5 - name: PortfolioBatchRequest fields: 8 - name: PortfolioBatchResponse fields: 6 - name: PortfolioCompany fields: 8 - name: PortfolioCreate fields: 4 - name: PortfolioEdit fields: 3 - name: PortfolioReportCreation fields: 2 - name: PortfolioVendor fields: 7 description: A party in the supply chain that makes goods and services available to a company in a portfolio - name: PortfolioVendors fields: 1 description: Vendors used by companies in a portfolio - name: ProductsResponseSchema fields: 4 - name: RemoveVendorsSchema fields: 1 description: Removes vendor-customer relations - name: ReportCreated fields: 1 - name: ReportCreatedFootprintDomainsResponseSchema fields: 7 - name: ReportCreatedIssuesResponseSchema fields: 7 - name: ReportCreatedPartnershipResponseSchema fields: 7 - name: ReportCreatedScorecardFootprintResponseSchema fields: 7 - name: ReportEventJsonResponseSchema fields: 7 - name: ReportRecentResponseSchema fields: 1 - name: ReportResponseSchema fields: 7 - name: ReportsCustomersSchema fields: 1 description: List of customers from the generated reports - name: ReportsSchema fields: 3 description: Represents a report for managed services - name: ReportsVendorsSchema fields: 1 description: List of vendors from the generated reports - name: ScoreByIndustrySchema fields: 3 - name: ScoreEntry fields: 2 - name: ScoreMetadata fields: 1 - name: ScorePlan fields: 3 - name: ScorePlanItem fields: 6 description: issue that require remediation - name: ScoreValue fields: 4 - name: ScorecardMultiscoresResponse fields: 2 - name: ScorecardTagGroupRequest fields: 1 description: Payload for creating a scorecard tag group - name: ScorecardTagGroupResponse fields: 2 description: Scorecard Tag Group - name: ScorecardTagGroupsResponse fields: 1 - name: ScorecardTagRequest fields: 4 description: a scorecard tag to create - name: ScorecardTagResponse fields: 3 description: the created scorecard tag - name: ScorecardTagsResponse fields: 2 - name: ScorecardUpdateTagResponse fields: 2 description: Updated scorecard tag - name: SearchCompaniesInBulkRequestSchema fields: 2 description: Search companies in bulk - name: SupplyChainRiskResponseSchema fields: 1 - name: UnarchiveActionPlansRequest fields: 1 description: List of action plan ids to unarchive - name: Unauthorized fields: 0 - name: UnmanagedCustomersList fields: 2 - name: UpdateBreachesSettings fields: 1 description: Array of breach ids/id and the vendor ids which needs to be marked as reported - name: UpdateCustomerAccess fields: 3 description: settings for customer access - name: UpdateCustomerUpdate fields: 4 description: settings and attachments for the customer update - name: UpdateCustomerUpdateSchema fields: 1 - name: UpdateFindingsSettings fields: 1 description: Array of finding ids/id and the vendor ids which needs to be marked as reported - name: UpdateVendorUpdate fields: 6 description: Settings for updating an existing vendor update, including metadata fields and optional vendor domain - name: UpdateVendorUpdateSchema fields: 1 - name: UpdateVendorsStatusesRequest fields: 8 description: settings for tags and statuses for vendors - name: UploadJsonNegotiateVendorListSchema fields: 2 description: a list of vendors - name: UploadVendorDomainsFileRequest fields: 1 description: vendor domains for upload - name: UploadVendorDomainsRequest fields: 1 description: List of vendors risk profiles - name: UserAccess fields: 2 - name: VendorUpdatesList fields: 2 - name: VendorsList fields: 2 - name: VendorsResponseSchema fields: 4 - name: addIpDomainTagResponse fields: 4 description: ip association schema - name: addIpDomainTagToDomainResponse fields: 3 description: domain association schema - name: addIpDomainTagToTagGroupSchemaResponse fields: 5 description: tag group schema - name: addScorecardTagToCompanySchemaResponse fields: 8 - name: allDomainsTagsResponseSchema fields: 1 - name: allIpsTagsResponseSchema fields: 1 - name: asiFacetsRequest fields: 3 - name: asiFacetsResponse fields: 1 - name: asiSearchRequest fields: 8 - name: asiSearchResponse fields: 8 - name: complianceFrameworkResponseSchema fields: 2 - name: complianceResponseSchema fields: 1 - name: createActionPlanResponseSchema fields: 1 - name: createAppJob fields: 2 - name: createAppJobResponse fields: 4 - name: createCustomScorecardRequest fields: 8 - name: createInvitationRequestSchema fields: 13 - name: createIpDomainTagGroupResponse fields: 5 description: ip domain tag group payload - name: customScorecardSchema fields: 20 - name: deleteCustomScorecardFilters fields: 1 - name: deleteCustomScorecardSources fields: 1 - name: feedbackValidationRequestRequest fields: 3 - name: feedbackValidationRequestRequestResponse fields: 1 - name: getActionPlanByIdSchemaResponse fields: 31 - name: getAsiActiveInfectionFamilyResponse fields: 6 - name: getAsiAssetIpResponse fields: 9 - name: getAsiAssetPortResponse fields: 11 - name: getAsiRansomwareResponse fields: 6 - name: getAsiThreatActorsResponse fields: 8 - name: getAttributionLogByParentDomainResponseSchema fields: 1 - name: getCveResponse fields: 8 - name: getNotificationsLatest7daysSchemaResponse fields: 5 description: Scorecard Tag Group - name: getPortfolio fields: 3 - name: removeDomainTagToDomainSchemaReponse fields: 3 description: domain association schema - name: removeIpDomainTagToTagGroupResponse fields: 5 description: tag group schema - name: tagSchema fields: 1 - name: updateAppJob fields: 3 - name: updateAppJobResponse fields: 7 - name: updateCompanyFields fields: 9 - name: updateCompanyFieldsByDomain fields: 9 - name: updateCustomScorecardFilters fields: 1 - name: updateCustomScorecardSources fields: 1 - name: updateIpDomainTagResponse fields: 4 description: Updated ip domain tag relationships: - from: PortfolioBatchRequest to: Portfolio type: belongs_to via: portfolioIds - from: PortfolioBatchResponse to: MultiscoreEntry type: has_many via: entries - from: MultiscorePaginatedResponse to: MultiscoreEntry type: has_many via: entries - from: ScorecardMultiscoresResponse to: Multiscore type: has_many via: multiscores - from: ScorePlan to: ScorePlanItem type: has_many via: entries - from: ScoreEntry to: ScoreValue type: has_one via: value - from: ScoreValue to: ScoreMetadata type: has_one via: score_metadata - from: ErrorResponse to: Error type: has_one via: error - from: PortfolioVendors to: PortfolioVendor type: has_many via: entries - from: PortfolioReportCreation to: Portfolio type: belongs_to via: portfolio_id