Class ListFindingsRequest

Inheritance

object

ListFindingsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Requests

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ListFindingsRequest : IOciRequest

Examples

Click here to see an example of how to use ListFindings request.

Properties

AccessLevel

Declaration

[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListFindingsRequest.AccessLevelEnum? AccessLevel { get; set; }

Property Value

Type	Description
ListFindingsRequest.AccessLevelEnum?	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.

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	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.

Field

Declaration

[HttpConverter(TargetEnum.Query, "field", CollectionFormatType.Multi)]
public List<ListFindingsRequest.FieldEnum> Field { get; set; }

Property Value

Type	Description
List<ListFindingsRequest.FieldEnum>	Specifies a subset of fields to be returned in the response.

FindingKey

Declaration

[HttpConverter(TargetEnum.Query, "findingKey")]
public string FindingKey { get; set; }

Property Value

Type	Description
string	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.

IsTopFinding

Declaration

[HttpConverter(TargetEnum.Query, "isTopFinding")]
public bool? IsTopFinding { get; set; }

Property Value

Type	Description
bool?	A filter to return only the findings that are marked as top findings.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public FindingLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
FindingLifecycleState?	A filter to return only the findings that match the specified lifecycle states.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	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.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique identifier for the request.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	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.

References

Declaration

[HttpConverter(TargetEnum.Query, "references")]
public SecurityAssessmentReferences? References { get; set; }

Property Value

Type	Description
SecurityAssessmentReferences?	An optional filter to return only findings that match the specified reference.

ScimQuery

Declaration

[HttpConverter(TargetEnum.Query, "scimQuery")]
public string ScimQuery { get; set; }

Property Value

Type

Description

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. 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.) **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')Supported fields:severityfindingKeyreferencetargetIdisTopFindingtitlecategoryremarksdetailssummaryisRiskModified

SecurityAssessmentId

Declaration

[Required(ErrorMessage = "SecurityAssessmentId is required.")]
[HttpConverter(TargetEnum.Path, "securityAssessmentId")]
public string SecurityAssessmentId { get; set; }

Property Value

Type	Description
string	The OCID of the security assessment.

Remarks

Required

Severity

Declaration

[HttpConverter(TargetEnum.Query, "severity")]
public ListFindingsRequest.SeverityEnum? Severity { get; set; }

Property Value

Type	Description
ListFindingsRequest.SeverityEnum?	A filter to return only findings of a particular risk level.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListFindingsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListFindingsRequest.SortByEnum?	The field to sort by. You can specify only one sort order(sortOrder). The default order for category is alphabetical.

TargetId

Declaration

[HttpConverter(TargetEnum.Query, "targetId")]
public string TargetId { get; set; }

Property Value

Type	Description
string	A filter to return only items related to a specific target OCID.

Implements

IOciRequest