Class UserAssessment

The details of the user assessment, which includes statistics related to target database users.

Inheritance

object

UserAssessment

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 UserAssessment

Properties

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 user 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 user 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 user 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 user 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 if the user assessment is set as a baseline. This is applicable only to saved user assessments.

IsDeviatedFromBaseline

Declaration

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

Property Value

Type	Description
bool?	Indicates if the user assessment deviates from the baseline.

LastComparedBaselineId

Declaration

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

Property Value

Type	Description
string	The OCID of the last user assessment baseline against which the latest 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 user assessment.

LifecycleState

Declaration

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

Property Value

Type	Description
UserAssessmentLifecycleState?	The current state of the user assessment.

Remarks

Required

Schedule

Declaration

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

Property Value

Type	Description
string

ScheduleAssessmentId

Declaration

[JsonProperty(PropertyName = "scheduleAssessmentId")]
public string ScheduleAssessmentId { get; set; }

Property Value

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

Statistics

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

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"}}

TargetIds

Declaration

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

Property Value

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

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 user 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 user 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 user assessment was last updated, in the format defined by RFC3339.

Remarks

Required

TriggeredBy

Declaration

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

Property Value

Type	Description
UserAssessment.TriggeredByEnum?	Indicates whether the user assessment was created by the system or the user.

Type

Declaration

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

Property Value

Type

Description

UserAssessment.TypeEnum?

The type of the user assessment. The possible types are: LATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment. SAVED: A saved user assessment. All user assessments are saved in the user assessment history. SAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database. COMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. It also keeps track of user count and target count for each profile available on the targets in a given compartment. It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.

Remarks

Required