/**
 *
 *
 * 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/ListFindings.ts.html |here} to see how to use ListFindingsRequest.
 */
export interface ListFindingsRequest extends common.BaseRequest {
    /**
     * The OCID of the security assessment.
     */
    "securityAssessmentId": string;
    /**
     * Unique identifier for the request.
     */
    "opcRequestId"?: string;
    /**
     * A filter to return only the findings that are marked as top findings.
     */
    "isTopFinding"?: boolean;
    /**
     * A filter to return only findings of a particular risk level.
     */
    "severity"?: ListFindingsRequest.Severity;
    /**
     * 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<ListFindingsRequest.ContainsSeverity>;
    /**
     * The category of the finding.
     */
    "category"?: string;
    /**
     * A filter to return only the findings that match the specified lifecycle states.
     */
    "lifecycleState"?: model.FindingLifecycleState;
    /**
     * An optional filter to return only findings that match the specified reference.
     */
    "references"?: model.SecurityAssessmentReferences;
    /**
     * An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references.
     */
    "containsReferences"?: Array<model.SecurityAssessmentReferences>;
    /**
     * 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;
    /**
     * A filter to return only resources that match the specified compartment OCID.
     */
    "compartmentId"?: string;
    /**
     * 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"?: ListFindingsRequest.AccessLevel;
    /**
     * A filter to return only items related to a specific target OCID.
     */
    "targetId"?: string;
    /**
     * An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids.
     */
    "targetIds"?: Array<string>;
    /**
   * The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2
  * of the System for Cross-Domain Identity Management (SCIM) specification, which is available
  * at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions,
  * text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format.
  * (Numeric and boolean values should not be quoted.)
  * <p>
  **Example:** |
  * scimQuery=(severity eq 'high') and (targetId eq 'target_1')
  * scimQuery=(category eq \"Users\") and (targetId eq \"target_1\")
  * scimQuery=(reference eq 'CIS') and (targetId eq 'target_1')
  * <p>
  Supported fields:
  * severity
  * findingKey
  * reference
  * targetId
  * isTopFinding
  * title
  * category
  * remarks
  * details
  * summary
  * isRiskModified
  *
   */
    "scimQuery"?: string;
    /**
     * Specifies a subset of fields to be returned in the response.
     */
    "field"?: Array<ListFindingsRequest.Field>;
    /**
     * The field to sort by. You can specify only one sort order(sortOrder). The default order for category is alphabetical.
     *
     */
    "sortBy"?: ListFindingsRequest.SortBy;
    /**
     * The sort order to use, either ascending (ASC) or descending (DESC).
     */
    "sortOrder"?: ListFindingsRequest.SortOrder;
    /**
     * Each finding in security assessment has an associated key (think of key as a finding's name).
     * For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.
     *
     */
    "findingKey"?: string;
}
export declare namespace ListFindingsRequest {
    enum Severity {
        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"
    }
    enum Field {
        Severity = "severity",
        FindingKey = "findingKey",
        Reference = "reference",
        TargetId = "targetId",
        IsTopFinding = "isTopFinding",
        Title = "title",
        Category = "category",
        Remarks = "remarks",
        Details = "details",
        Summary = "summary",
        IsRiskModified = "isRiskModified"
    }
    enum SortBy {
        Category = "category",
        FindingKey = "findingKey",
        Severity = "severity"
    }
    enum SortOrder {
        Asc = "ASC",
        Desc = "DESC"
    }
}