Show / Hide Table of Contents

Class ListChecksRequest

Inheritance
object
ListChecksRequest
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 ListChecksRequest : IOciRequest
Examples

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

Properties

AccessLevel

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

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<ListChecksRequest.ContainsSeverityEnum> ContainsSeverity { get; set; }
Property Value
Type Description
List<ListChecksRequest.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.

Key

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

Each check in security assessment has an associated key (think of key as a check's name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks.

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.

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

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListChecksRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListChecksRequest.SortByEnum?

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

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListChecksRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListChecksRequest.SortOrderEnum?

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

SuggestedSeverity

Declaration
[HttpConverter(TargetEnum.Query, "suggestedSeverity")]
public ListChecksRequest.SuggestedSeverityEnum? SuggestedSeverity { get; set; }
Property Value
Type Description
ListChecksRequest.SuggestedSeverityEnum?

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

Implements

IOciRequest
In this article
Back to top