Class ListSecurityAssessmentsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListSecurityAssessmentsRequest : IOciRequest
Examples
Click here to see an example of how to use ListSecurityAssessments request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListSecurityAssessmentsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListSecurityAssessmentsRequest.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. |
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. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only resources that match the specified display name. |
IsBaseline
Declaration
[HttpConverter(TargetEnum.Query, "isBaseline")]
public bool? IsBaseline { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to return only the security assessments that are set as a baseline. |
IsScheduleAssessment
Declaration
[HttpConverter(TargetEnum.Query, "isScheduleAssessment")]
public bool? IsScheduleAssessment { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to return only security assessments of type save schedule. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public SecurityAssessmentLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
SecurityAssessmentLifecycleState? | A filter to return only resources that match the specified lifecycle state. |
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. |
ScheduleAssessmentId
Declaration
[HttpConverter(TargetEnum.Query, "scheduleAssessmentId")]
public string ScheduleAssessmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the security assessment of type SAVE_SCHEDULE. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListSecurityAssessmentsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListSecurityAssessmentsRequest.SortByEnum? | The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListSecurityAssessmentsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListSecurityAssessmentsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
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. |
TimeCreatedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.
Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.
|
TimeCreatedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedLessThan")]
public DateTime? TimeCreatedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Search for resources that were created before a specific date.
Specifying this parameter corresponding |
TriggeredBy
Declaration
[HttpConverter(TargetEnum.Query, "triggeredBy")]
public ListSecurityAssessmentsRequest.TriggeredByEnum? TriggeredBy { get; set; }
Property Value
Type | Description |
---|---|
ListSecurityAssessmentsRequest.TriggeredByEnum? | A filter to return only security asessments that were created by either user or system. |
Type
Declaration
[HttpConverter(TargetEnum.Query, "type")]
public ListSecurityAssessmentsRequest.TypeEnum? Type { get; set; }
Property Value
Type | Description |
---|---|
ListSecurityAssessmentsRequest.TypeEnum? | A filter to return only items that match the specified security assessment type. |