/** * * * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; import common = require("oci-common"); /** * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/datasafe/ListChecks.ts.html |here} to see how to use ListChecksRequest. */ export interface ListChecksRequest extends common.BaseRequest { /** * The OCID of the security assessment. */ "securityAssessmentId": string; /** * Unique identifier for the request. */ "opcRequestId"?: string; /** * For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "limit"?: number; /** * For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "page"?: string; /** * The sort order to use, either ascending (ASC) or descending (DESC). */ "sortOrder"?: ListChecksRequest.SortOrder; /** * The field to sort by. You can specify only one sort order(sortOrder). The default order for title is ascending. * */ "sortBy"?: ListChecksRequest.SortBy; /** * A filter to return only checks of a particular risk level. */ "suggestedSeverity"?: ListChecksRequest.SuggestedSeverity; /** * A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels. */ "containsSeverity"?: Array; /** * An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references. */ "containsReferences"?: Array; /** * Default is false. * When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. * */ "compartmentIdInSubtree"?: boolean; /** * Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. * Setting this to ACCESSIBLE returns only those compartments for which the * user has INSPECT permissions directly or indirectly (permissions can be on a * resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. * */ "accessLevel"?: ListChecksRequest.AccessLevel; /** * Each check in security assessment has an associated key (think of key as a check's name). * For a given check, the key will be the same across targets. The user can use these keys to filter the checks. * */ "key"?: string; } export declare namespace ListChecksRequest { enum SortOrder { Asc = "ASC", Desc = "DESC" } enum SortBy { Title = "title", Category = "category" } enum SuggestedSeverity { High = "HIGH", Medium = "MEDIUM", Low = "LOW", Evaluate = "EVALUATE", Advisory = "ADVISORY", Pass = "PASS", Deferred = "DEFERRED" } enum ContainsSeverity { High = "HIGH", Medium = "MEDIUM", Low = "LOW", Evaluate = "EVALUATE", Advisory = "ADVISORY", Pass = "PASS", Deferred = "DEFERRED" } enum AccessLevel { Restricted = "RESTRICTED", Accessible = "ACCESSIBLE" } }