Class ListFindingAnalyticsRequest

Inheritance
object
ListFindingAnalyticsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListFindingAnalyticsRequest : IOciRequest
Examples

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListFindingAnalyticsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListFindingAnalyticsRequest.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.

Category

Declaration
[HttpConverter(TargetEnum.Query, "category")]
public string Category { get; set; }
Property Value
Type Description
string

The category of the finding.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

A filter to return only resources that match the specified compartment OCID.
Remarks

Required

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.

ContainsReferences

Declaration
[HttpConverter(TargetEnum.Query, "containsReferences", CollectionFormatType.Multi)]
public List<SecurityAssessmentReferences> ContainsReferences { get; set; }
Property Value
Type Description
List<SecurityAssessmentReferences>

An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references.

ContainsSeverity

Declaration
[HttpConverter(TargetEnum.Query, "containsSeverity", CollectionFormatType.Multi)]
public List<ListFindingAnalyticsRequest.ContainsSeverityEnum> ContainsSeverity { get; set; }
Property Value
Type Description
List<ListFindingAnalyticsRequest.ContainsSeverityEnum>

A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels.

FindingKey

Declaration
[HttpConverter(TargetEnum.Query, "findingKey")]
public string FindingKey { get; set; }
Property Value
Type Description
string

The unique key that identifies the finding. It is a string and unique within a security assessment.

GroupBy

Declaration
[HttpConverter(TargetEnum.Query, "groupBy")]
public ListFindingAnalyticsRequest.GroupByEnum? GroupBy { get; set; }
Property Value
Type Description
ListFindingAnalyticsRequest.GroupByEnum?

Attribute by which the finding analytics data should be grouped.

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.

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.

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')scimQuery=(category eq "Users") and (reference eq 'CIS')Supported fields:severityreferencetitlecategory

Severity

Declaration
[HttpConverter(TargetEnum.Query, "severity")]
public ListFindingAnalyticsRequest.SeverityEnum? Severity { get; set; }
Property Value
Type Description
ListFindingAnalyticsRequest.SeverityEnum?

A filter to return only findings of a particular risk level.

TargetDatabaseGroupId

Declaration
[HttpConverter(TargetEnum.Query, "targetDatabaseGroupId")]
public string TargetDatabaseGroupId { get; set; }
Property Value
Type Description
string

A filter to return the target database group that matches the specified OCID.

TargetIds

Declaration
[HttpConverter(TargetEnum.Query, "targetIds", CollectionFormatType.Multi)]
public List<string> TargetIds { get; set; }
Property Value
Type Description
List<string>

An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids.

TopFindingStatus

Declaration
[HttpConverter(TargetEnum.Query, "topFindingStatus")]
public FindingAnalyticsDimensions.TopFindingStatusEnum? TopFindingStatus { get; set; }
Property Value
Type Description
FindingAnalyticsDimensions.TopFindingStatusEnum?

An optional filter to return only the top finding that match the specified status.

Implements