@datadog/datadog-api-client 1.39.0 → 1.41.0

package/dist/packages/datadog-api-client-v2/apis/SecurityMonitoringApi.d.ts

@@ -20,6 +20,7 @@ import { GetRuleVersionHistoryResponse } from "../models/GetRuleVersionHistoryRe
 import { GetSBOMResponse } from "../models/GetSBOMResponse";
 import { HistoricalJobResponse } from "../models/HistoricalJobResponse";
 import { JobCreateResponse } from "../models/JobCreateResponse";
+import { ListAssetsSBOMsResponse } from "../models/ListAssetsSBOMsResponse";
 import { ListFindingsResponse } from "../models/ListFindingsResponse";
 import { ListHistoricalJobsResponse } from "../models/ListHistoricalJobsResponse";
 import { ListVulnerabilitiesResponse } from "../models/ListVulnerabilitiesResponse";
@@ -27,6 +28,7 @@ import { ListVulnerableAssetsResponse } from "../models/ListVulnerableAssetsResp
 import { NotificationRuleResponse } from "../models/NotificationRuleResponse";
 import { PatchNotificationRuleParameters } from "../models/PatchNotificationRuleParameters";
 import { RunHistoricalJobRequest } from "../models/RunHistoricalJobRequest";
+import { SBOMComponentLicenseType } from "../models/SBOMComponentLicenseType";
 import { SecurityFilterCreateRequest } from "../models/SecurityFilterCreateRequest";
 import { SecurityFilterResponse } from "../models/SecurityFilterResponse";
 import { SecurityFiltersResponse } from "../models/SecurityFiltersResponse";
@@ -97,14 +99,15 @@ export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestF
     getSignalNotificationRules(_options?: Configuration): Promise<RequestContext>;
     getVulnerabilityNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>;
     getVulnerabilityNotificationRules(_options?: Configuration): Promise<RequestContext>;
-    listFindings(pageLimit?: number, snapshotTimestamp?: number, pageCursor?: string, filterTags?: string, filterEvaluationChangedAt?: string, filterMuted?: boolean, filterRuleId?: string, filterRuleName?: string, filterResourceType?: string, filterDiscoveryTimestamp?: string, filterEvaluation?: FindingEvaluation, filterStatus?: FindingStatus, filterVulnerabilityType?: Array<FindingVulnerabilityType>, detailedFindings?: boolean, _options?: Configuration): Promise<RequestContext>;
+    listAssetsSBOMs(pageToken?: string, pageNumber?: number, filterAssetType?: AssetType, filterAssetName?: string, filterPackageName?: string, filterPackageVersion?: string, filterLicenseName?: string, filterLicenseType?: SBOMComponentLicenseType, _options?: Configuration): Promise<RequestContext>;
+    listFindings(pageLimit?: number, snapshotTimestamp?: number, pageCursor?: string, filterTags?: string, filterEvaluationChangedAt?: string, filterMuted?: boolean, filterRuleId?: string, filterRuleName?: string, filterResourceType?: string, filterResourceId?: string, filterDiscoveryTimestamp?: string, filterEvaluation?: FindingEvaluation, filterStatus?: FindingStatus, filterVulnerabilityType?: Array<FindingVulnerabilityType>, detailedFindings?: boolean, _options?: Configuration): Promise<RequestContext>;
     listHistoricalJobs(pageSize?: number, pageNumber?: number, sort?: string, filterQuery?: string, _options?: Configuration): Promise<RequestContext>;
     listSecurityFilters(_options?: Configuration): Promise<RequestContext>;
     listSecurityMonitoringRules(pageSize?: number, pageNumber?: number, _options?: Configuration): Promise<RequestContext>;
     listSecurityMonitoringSignals(filterQuery?: string, filterFrom?: Date, filterTo?: Date, sort?: SecurityMonitoringSignalsSort, pageCursor?: string, pageLimit?: number, _options?: Configuration): Promise<RequestContext>;
     listSecurityMonitoringSuppressions(_options?: Configuration): Promise<RequestContext>;
-    listVulnerabilities(pageToken?: string, pageNumber?: number, filterType?: VulnerabilityType, filterCvssBaseScoreOp?: number, filterCvssBaseSeverity?: VulnerabilitySeverity, filterCvssBaseVector?: string, filterCvssDatadogScoreOp?: number, filterCvssDatadogSeverity?: VulnerabilitySeverity, filterCvssDatadogVector?: string, filterStatus?: VulnerabilityStatus, filterTool?: VulnerabilityTool, filterLibraryName?: string, filterLibraryVersion?: string, filterAdvisoryId?: string, filterRisksExploitationProbability?: boolean, filterRisksPocExploitAvailable?: boolean, filterRisksExploitAvailable?: boolean, filterRisksEpssScoreOp?: number, filterRisksEpssSeverity?: VulnerabilitySeverity, filterLanguage?: string, filterEcosystem?: VulnerabilityEcosystem, filterCodeLocationLocation?: string, filterCodeLocationFilePath?: string, filterCodeLocationMethod?: string, filterFixAvailable?: boolean, filterRepoDigests?: string, filterAssetName?: string, filterAssetType?: AssetType, filterAssetVersionFirst?: string, filterAssetVersionLast?: string, filterAssetRepositoryUrl?: string, filterAssetRisksInProduction?: boolean, filterAssetRisksUnderAttack?: boolean, filterAssetRisksIsPubliclyAccessible?: boolean, filterAssetRisksHasPrivilegedAccess?: boolean, filterAssetRisksHasAccessToSensitiveData?: boolean, filterAssetEnvironments?: string, filterAssetArch?: string, filterAssetOperatingSystemName?: string, filterAssetOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>;
-    listVulnerableAssets(pageToken?: string, pageNumber?: number, filterName?: string, filterType?: AssetType, filterVersionFirst?: string, filterVersionLast?: string, filterRepositoryUrl?: string, filterRisksInProduction?: boolean, filterRisksUnderAttack?: boolean, filterRisksIsPubliclyAccessible?: boolean, filterRisksHasPrivilegedAccess?: boolean, filterRisksHasAccessToSensitiveData?: boolean, filterEnvironments?: string, filterArch?: string, filterOperatingSystemName?: string, filterOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>;
+    listVulnerabilities(pageToken?: string, pageNumber?: number, filterType?: VulnerabilityType, filterCvssBaseScoreOp?: number, filterCvssBaseSeverity?: VulnerabilitySeverity, filterCvssBaseVector?: string, filterCvssDatadogScoreOp?: number, filterCvssDatadogSeverity?: VulnerabilitySeverity, filterCvssDatadogVector?: string, filterStatus?: VulnerabilityStatus, filterTool?: VulnerabilityTool, filterLibraryName?: string, filterLibraryVersion?: string, filterAdvisoryId?: string, filterRisksExploitationProbability?: boolean, filterRisksPocExploitAvailable?: boolean, filterRisksExploitAvailable?: boolean, filterRisksEpssScoreOp?: number, filterRisksEpssSeverity?: VulnerabilitySeverity, filterLanguage?: string, filterEcosystem?: VulnerabilityEcosystem, filterCodeLocationLocation?: string, filterCodeLocationFilePath?: string, filterCodeLocationMethod?: string, filterFixAvailable?: boolean, filterRepoDigests?: string, filterOrigin?: string, filterAssetName?: string, filterAssetType?: AssetType, filterAssetVersionFirst?: string, filterAssetVersionLast?: string, filterAssetRepositoryUrl?: string, filterAssetRisksInProduction?: boolean, filterAssetRisksUnderAttack?: boolean, filterAssetRisksIsPubliclyAccessible?: boolean, filterAssetRisksHasPrivilegedAccess?: boolean, filterAssetRisksHasAccessToSensitiveData?: boolean, filterAssetEnvironments?: string, filterAssetTeams?: string, filterAssetArch?: string, filterAssetOperatingSystemName?: string, filterAssetOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>;
+    listVulnerableAssets(pageToken?: string, pageNumber?: number, filterName?: string, filterType?: AssetType, filterVersionFirst?: string, filterVersionLast?: string, filterRepositoryUrl?: string, filterRisksInProduction?: boolean, filterRisksUnderAttack?: boolean, filterRisksIsPubliclyAccessible?: boolean, filterRisksHasPrivilegedAccess?: boolean, filterRisksHasAccessToSensitiveData?: boolean, filterEnvironments?: string, filterTeams?: string, filterArch?: string, filterOperatingSystemName?: string, filterOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>;
     muteFindings(body: BulkMuteFindingsRequest, _options?: Configuration): Promise<RequestContext>;
     patchSignalNotificationRule(id: string, body: PatchNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>;
     patchVulnerabilityNotificationRule(id: string, body: PatchNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>;
@@ -392,6 +395,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getVulnerabilityNotificationRules(response: ResponseContext): Promise<any>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listAssetsSBOMs
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listAssetsSBOMs(response: ResponseContext): Promise<ListAssetsSBOMsResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -843,6 +854,48 @@ export interface SecurityMonitoringApiGetVulnerabilityNotificationRuleRequest {
      */
     id: string;
 }
+export interface SecurityMonitoringApiListAssetsSBOMsRequest {
+    /**
+     * Its value must come from the `links` section of the response of the first request. Do not manually edit it.
+     * @type string
+     */
+    pageToken?: string;
+    /**
+     * The page number to be retrieved. It should be equal to or greater than 1.
+     * @type number
+     */
+    pageNumber?: number;
+    /**
+     * The type of the assets for the SBOM request.
+     * @type AssetType
+     */
+    filterAssetType?: AssetType;
+    /**
+     * The name of the asset for the SBOM request.
+     * @type string
+     */
+    filterAssetName?: string;
+    /**
+     * The name of the component that is a dependency of an asset.
+     * @type string
+     */
+    filterPackageName?: string;
+    /**
+     * The version of the component that is a dependency of an asset.
+     * @type string
+     */
+    filterPackageVersion?: string;
+    /**
+     * The software license name of the component that is a dependency of an asset.
+     * @type string
+     */
+    filterLicenseName?: string;
+    /**
+     * The software license type of the component that is a dependency of an asset.
+     * @type SBOMComponentLicenseType
+     */
+    filterLicenseType?: SBOMComponentLicenseType;
+}
 export interface SecurityMonitoringApiListFindingsRequest {
     /**
      * Limit the number of findings returned. Must be <= 1000.
@@ -889,6 +942,11 @@ export interface SecurityMonitoringApiListFindingsRequest {
      * @type string
      */
     filterResourceType?: string;
+    /**
+     * Return only findings for the specified resource id.
+     * @type string
+     */
+    filterResourceId?: string;
     /**
      * Return findings that were found on a specified date (Unix ms) or date range (using comparison operators).
      * @type string
@@ -1112,6 +1170,11 @@ export interface SecurityMonitoringApiListVulnerabilitiesRequest {
      * @type string
      */
     filterRepoDigests?: string;
+    /**
+     * Filter by origin.
+     * @type string
+     */
+    filterOrigin?: string;
     /**
      * Filter by asset name.
      * @type string
@@ -1167,6 +1230,11 @@ export interface SecurityMonitoringApiListVulnerabilitiesRequest {
      * @type string
      */
     filterAssetEnvironments?: string;
+    /**
+     * Filter by asset teams.
+     * @type string
+     */
+    filterAssetTeams?: string;
     /**
      * Filter by asset architecture.
      * @type string
@@ -1249,6 +1317,11 @@ export interface SecurityMonitoringApiListVulnerableAssetsRequest {
      * @type string
      */
     filterEnvironments?: string;
+    /**
+     * Filter by teams.
+     * @type string
+     */
+    filterTeams?: string;
     /**
      * Filter by architecture.
      * @type string
@@ -1578,6 +1651,23 @@ export declare class SecurityMonitoringApi {
      * @param param The request object
      */
     getVulnerabilityNotificationRules(options?: Configuration): Promise<any>;
+    /**
+     * Get a list of assets SBOMs for an organization.
+     *
+     * ### Pagination
+     *
+     * Please review the [Pagination section](#pagination) for the "List Vulnerabilities" endpoint.
+     *
+     * ### Filtering
+     *
+     * Please review the [Filtering section](#filtering) for the "List Vulnerabilities" endpoint.
+     *
+     * ### Metadata
+     *
+     * Please review the [Metadata section](#metadata) for the "List Vulnerabilities" endpoint.
+     * @param param The request object
+     */
+    listAssetsSBOMs(param?: SecurityMonitoringApiListAssetsSBOMsRequest, options?: Configuration): Promise<ListAssetsSBOMsResponse>;
     /**
      * Get a list of findings. These include both misconfigurations and identity risks.
      *
@@ -1611,6 +1701,7 @@ export declare class SecurityMonitoringApi {
      * - `external_id`: The resource external ID related to the finding.
      * - `description`: The description and remediation steps for the finding.
      * - `datadog_link`: The Datadog relative link for the finding.
+     * - `ip_addresses`: The list of private IP addresses for the resource related to the finding.
      *
      * ### Response
      *