Get-OCIDatasafeFindingAnalyticsList

SYNOPSIS

Invokes DataSafe service - ListFindingAnalytics operation.

SYNTAX

Limit

Get-OCIDatasafeFindingAnalyticsList -CompartmentId <String> [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-IsTopFinding <Boolean>] [-GroupBy <GroupByEnum>] [-TopFindingStatus <TopFindingStatusEnum>] [-Severity <SeverityEnum>] [-FindingKey <String>] [-OpcRequestId <String>] [-Limit <Int32>] [-Page <String>] [-TargetDatabaseGroupId <String>] [-ContainsReferences <System.Collections.Generic.List`1[Oci.DatasafeService.Models.SecurityAssessmentReferences]>] [-TargetIds <System.Collections.Generic.List`1[System.String]>] [-Category <String>] [-ContainsSeverity <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingAnalyticsRequest+ContainsSeverityEnum]>] [-ScimQuery <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatasafeFindingAnalyticsList -CompartmentId <String> [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-IsTopFinding <Boolean>] [-GroupBy <GroupByEnum>] [-TopFindingStatus <TopFindingStatusEnum>] [-Severity <SeverityEnum>] [-FindingKey <String>] [-OpcRequestId <String>] [-Page <String>] [-TargetDatabaseGroupId <String>] [-ContainsReferences <System.Collections.Generic.List`1[Oci.DatasafeService.Models.SecurityAssessmentReferences]>] [-TargetIds <System.Collections.Generic.List`1[System.String]>] [-Category <String>] [-ContainsSeverity <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingAnalyticsRequest+ContainsSeverityEnum]>] [-ScimQuery <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state of security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey, and as well as get the list of the targets that match the condition. This data is especially useful content for the statistic chart or to support analytics. When you perform the ListFindingAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

PARAMETERS

-AccessLevel

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.

Type: AccessLevelEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Restricted, Accessible

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Category

The category of the finding.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CompartmentId

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CompartmentIdInSubtree

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.

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContainsReferences

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

Type: System.Collections.Generic.List`1[Oci.DatasafeService.Models.SecurityAssessmentReferences]
Parameter Sets: (All)
Aliases: None
Accepted values: Stig, Cis, Gdpr

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ContainsSeverity

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

Type: System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingAnalyticsRequest+ContainsSeverityEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: High, Medium, Low, Evaluate, Advisory, Pass, Deferred

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FindingKey

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupBy

Attribute by which the finding analytics data should be grouped.

Type: GroupByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: FindingKeyAndTopFindingStatus, FindingKeyAndSeverity, Severity

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsTopFinding

A filter to return only the findings that are marked as top findings.

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

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.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

Unique identifier for the request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

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.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ScimQuery

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: severity reference title category

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Severity

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

Type: SeverityEnum
Parameter Sets: (All)
Aliases: None
Accepted values: High, Medium, Low, Evaluate, Advisory, Pass, Deferred

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetDatabaseGroupId

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetIds

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

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TopFindingStatus

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

Type: TopFindingStatusEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Risk, Evaluate, Advisory, Pass, Deferred

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

• Oci.DatasafeService.Models.FindingAnalyticsCollection
• Oci.DatasafeService.Responses.ListFindingAnalyticsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples