Get-OCIDatasafeFindingsList

SYNOPSIS

Invokes DataSafe service - ListFindings operation.

SYNTAX

Limit

Get-OCIDatasafeFindingsList -SecurityAssessmentId <String> [-OpcRequestId <String>] [-IsTopFinding <Boolean>] [-Severity <SeverityEnum>] [-ContainsSeverity <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingsRequest+ContainsSeverityEnum]>] [-Category <String>] [-LifecycleState <FindingLifecycleState>] [-References <SecurityAssessmentReferences>] [-ContainsReferences <System.Collections.Generic.List`1[Oci.DatasafeService.Models.SecurityAssessmentReferences]>] [-Limit <Int32>] [-Page <String>] [-CompartmentId <String>] [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-TargetId <String>] [-TargetIds <System.Collections.Generic.List`1[System.String]>] [-ScimQuery <String>] [-Field <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingsRequest+FieldEnum]>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-FindingKey <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatasafeFindingsList -SecurityAssessmentId <String> [-OpcRequestId <String>] [-IsTopFinding <Boolean>] [-Severity <SeverityEnum>] [-ContainsSeverity <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingsRequest+ContainsSeverityEnum]>] [-Category <String>] [-LifecycleState <FindingLifecycleState>] [-References <SecurityAssessmentReferences>] [-ContainsReferences <System.Collections.Generic.List`1[Oci.DatasafeService.Models.SecurityAssessmentReferences]>] [-Page <String>] [-CompartmentId <String>] [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-TargetId <String>] [-TargetIds <System.Collections.Generic.List`1[System.String]>] [-ScimQuery <String>] [-Field <System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingsRequest+FieldEnum]>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-FindingKey <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists all the findings for the specified assessment except for type TEMPLATE. If the assessment is of type TEMPLATE_BASELINE, the findings returned are the security checks with the user-defined severity from the template.

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: False
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.ListFindingsRequest+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

-Field

Specifies a subset of fields to be returned in the response.

Type: System.Collections.Generic.List`1[Oci.DatasafeService.Requests.ListFindingsRequest+FieldEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Severity, FindingKey, Reference, TargetId, IsTopFinding, Title, Category, Remarks, Details, Summary, IsRiskModified

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

-FindingKey

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.

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

-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

-LifecycleState

A filter to return only the findings that match the specified lifecycle states.

Type: FindingLifecycleState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Updating, NeedsAttention, Failed

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

-References

An optional filter to return only findings that match the specified reference.

Type: 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

-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') 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: severity findingKey reference targetId isTopFinding title category remarks details summary isRiskModified

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

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

-SecurityAssessmentId

The OCID of the security assessment.

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

Required: True
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

-SortBy

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

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Category, FindingKey, Severity

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

-SortOrder

The sort order to use, either ascending (ASC) or descending (DESC).

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

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

-TargetId

A filter to return only items related to a specific target 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

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.FindingSummary
• Oci.DatasafeService.Responses.ListFindingsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples