Class SecurityAssessment

A security assessment that provides an overall insight into your database security posture. The security assessment results are based on the analysis of your database configurations, user accounts, and security controls. For more information, see Security Assessment Overview.

Inheritance

object

SecurityAssessment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class SecurityAssessment

Properties

BaselineAssessmentId

Declaration

[JsonProperty(PropertyName = "baselineAssessmentId")]
public string BaselineAssessmentId { get; set; }

Property Value

Type	Description
string	The ocid of a security assessment which is of type TEMPLATE_BASELINE, this will be null or empty when type is TEMPLATE_BASELINE.

Checks

Declaration

[JsonProperty(PropertyName = "checks")]
public List<Check> Checks { get; set; }

Property Value

Type	Description
List<Check>	The security checks to be evaluated for type template.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the security assessment.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the security assessment.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the security assessment.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the security assessment.

Remarks

Required

IgnoredAssessmentIds

Declaration

[JsonProperty(PropertyName = "ignoredAssessmentIds")]
public List<object> IgnoredAssessmentIds { get; set; }

Property Value

Type	Description
List<object>	List containing maps as values. Example: {"Operations": [ {"CostCenter": "42"} ] }

IgnoredTargets

Declaration

[JsonProperty(PropertyName = "ignoredTargets")]
public List<object> IgnoredTargets { get; set; }

Property Value

Type	Description
List<object>	List containing maps as values. Example: {"Operations": [ {"CostCenter": "42"} ] }

IsAssessmentScheduled

Declaration

[JsonProperty(PropertyName = "isAssessmentScheduled")]
public bool? IsAssessmentScheduled { get; set; }

Property Value

Type	Description
bool?	Indicates whether the assessment is scheduled to run.

IsBaseline

Declaration

[JsonProperty(PropertyName = "isBaseline")]
public bool? IsBaseline { get; set; }

Property Value

Type	Description
bool?	Indicates whether or not the security assessment is set as a baseline. This is applicable only for saved security assessments.

IsDeviatedFromBaseline

Declaration

[JsonProperty(PropertyName = "isDeviatedFromBaseline")]
public bool? IsDeviatedFromBaseline { get; set; }

Property Value

Type	Description
bool?	Indicates if the assessment has deviated from the baseline.

LastComparedBaselineId

Declaration

[JsonProperty(PropertyName = "lastComparedBaselineId")]
public string LastComparedBaselineId { get; set; }

Property Value

Type	Description
string	The OCID of the baseline against which the latest security assessment was compared.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Details about the current state of the security assessment.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityAssessmentLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
SecurityAssessmentLifecycleState?	The current state of the security assessment.

Remarks

Required

Link

Declaration

[JsonProperty(PropertyName = "link")]
public string Link { get; set; }

Property Value

Type	Description
string	The summary of findings for the security assessment

Schedule

Declaration

[JsonProperty(PropertyName = "schedule")]
public string Schedule { get; set; }

Property Value

Type	Description
string

ScheduleSecurityAssessmentId

Declaration

[JsonProperty(PropertyName = "scheduleSecurityAssessmentId")]
public string ScheduleSecurityAssessmentId { get; set; }

Property Value

Type	Description
string	The OCID of the security assessment that is responsible for creating this scheduled save assessment.

Statistics

Declaration

[JsonProperty(PropertyName = "statistics")]
public SecurityAssessmentStatistics Statistics { get; set; }

Property Value

Type	Description
SecurityAssessmentStatistics

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TargetDatabaseGroupId

Declaration

[JsonProperty(PropertyName = "targetDatabaseGroupId")]
public string TargetDatabaseGroupId { get; set; }

Property Value

Type	Description
string	The OCID of the target database group that the group assessment is created for.

TargetIds

Declaration

[Required(ErrorMessage = "TargetIds is required.")]
[JsonProperty(PropertyName = "targetIds")]
public List<string> TargetIds { get; set; }

Property Value

Type	Description
List<string>	Array of database target OCIDs.

Remarks

Required

TargetType

Declaration

[JsonProperty(PropertyName = "targetType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityAssessmentTargetType? TargetType { get; set; }

Property Value

Type	Description
SecurityAssessmentTargetType?	Indicates whether the security assessment is for a target database or a target database group.

TargetVersion

Declaration

[JsonProperty(PropertyName = "targetVersion")]
public string TargetVersion { get; set; }

Property Value

Type	Description
string	The version of the target database.

TemplateAssessmentId

Declaration

[JsonProperty(PropertyName = "templateAssessmentId")]
public string TemplateAssessmentId { get; set; }

Property Value

Type	Description
string	The ocid of a security assessment which is of type TEMPLATE, this will be null or empty when type is TEMPLATE.

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the security assessment was created, in the format defined by RFC3339.

Remarks

Required

TimeLastAssessed

Declaration

[JsonProperty(PropertyName = "timeLastAssessed")]
public DateTime? TimeLastAssessed { get; set; }

Property Value

Type	Description
DateTime?	The date and time the security assessment was last executed, in the format defined by RFC3339.

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the security assessment was last updated, in the format defined by RFC3339.

Remarks

Required

TriggeredBy

Declaration

[JsonProperty(PropertyName = "triggeredBy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityAssessment.TriggeredByEnum? TriggeredBy { get; set; }

Property Value

Type	Description
SecurityAssessment.TriggeredByEnum?	Indicates whether the security assessment was created by system or by a user.

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityAssessment.TypeEnum? Type { get; set; }

Property Value

Type	Description
SecurityAssessment.TypeEnum?	The type of this security assessment. The possible types are: LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. SAVED: A saved security assessment. LATEST assessments are always saved in order to maintain the history of runs. A SAVED assessment is also generated by a 'refresh' action (triggered by the user). SAVE_SCHEDULE: The schedule for periodic saves of LATEST assessments. COMPARTMENT: An automatically managed assessment type that stores all details of targets in one compartment. This type keeps an up-to-date assessment of all database risks in one compartment. It is automatically updated when the latest assessment or refresh action is executed. It is also automatically updated when a target is deleted or move to a different compartment.

Type

Description

SecurityAssessment.TypeEnum?

The type of this security assessment. The possible types are:
LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. SAVED: A saved security assessment. LATEST assessments are always saved in order to maintain the history of runs. A SAVED assessment is also generated by a 'refresh' action (triggered by the user). SAVE_SCHEDULE: The schedule for periodic saves of LATEST assessments. COMPARTMENT: An automatically managed assessment type that stores all details of targets in one compartment. This type keeps an up-to-date assessment of all database risks in one compartment. It is automatically updated when the latest assessment or refresh action is executed. It is also automatically updated when a target is deleted or move to a different compartment.

Remarks

Required