Class SensitiveDataModel
A sensitive data model is a collection of sensitive columns and their referential relationships. It helps understand the sensitive data landscape, track changes, and efficiently enable security controls such as data masking. It can be managed either manually or by performing sensitive data discovery on a reference target database. Learn more.
Inherited Members
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class SensitiveDataModel
Properties
AppSuiteName
Declaration
[Required(ErrorMessage = "AppSuiteName is required.")]
[JsonProperty(PropertyName = "appSuiteName")]
public string AppSuiteName { get; set; }
Property Value
Type | Description |
---|---|
string | The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications. |
Remarks
Required
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 sensitive data model. |
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
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | The description of the sensitive data model. |
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 sensitive data model. |
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
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the sensitive data model. |
Remarks
Required
IsAppDefinedRelationDiscoveryEnabled
Declaration
[Required(ErrorMessage = "IsAppDefinedRelationDiscoveryEnabled is required.")]
[JsonProperty(PropertyName = "isAppDefinedRelationDiscoveryEnabled")]
public bool? IsAppDefinedRelationDiscoveryEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships. |
Remarks
Required
IsIncludeAllSchemas
Declaration
[Required(ErrorMessage = "IsIncludeAllSchemas is required.")]
[JsonProperty(PropertyName = "isIncludeAllSchemas")]
public bool? IsIncludeAllSchemas { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). |
Remarks
Required
IsIncludeAllSensitiveTypes
Declaration
[Required(ErrorMessage = "IsIncludeAllSensitiveTypes is required.")]
[JsonProperty(PropertyName = "isIncludeAllSensitiveTypes")]
public bool? IsIncludeAllSensitiveTypes { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if all the existing sensitive types should be used by data discovery jobs.If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. |
Remarks
Required
IsSampleDataCollectionEnabled
Declaration
[Required(ErrorMessage = "IsSampleDataCollectionEnabled is required.")]
[JsonProperty(PropertyName = "isSampleDataCollectionEnabled")]
public bool? IsSampleDataCollectionEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DiscoveryLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
DiscoveryLifecycleState? | The current state of the sensitive data model. |
Remarks
Required
SchemasForDiscovery
Declaration
[JsonProperty(PropertyName = "schemasForDiscovery")]
public List<string> SchemasForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The schemas to be scanned by data discovery jobs. |
SensitiveTypeIdsForDiscovery
Declaration
[JsonProperty(PropertyName = "sensitiveTypeIdsForDiscovery")]
public List<string> SensitiveTypeIdsForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The OCIDs of the sensitive types to be used by data discovery jobs. |
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"}} |
TablesForDiscovery
Declaration
[JsonProperty(PropertyName = "tablesForDiscovery")]
public List<TablesForDiscovery> TablesForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<TablesForDiscovery> | The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}]. |
TargetId
Declaration
[Required(ErrorMessage = "TargetId is required.")]
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the reference target database associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database. |
Remarks
Required
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 sensitive data model was created, in the format defined by RFC3339. |
Remarks
Required
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 sensitive data model was last updated, in the format defined by RFC3339. |
Remarks
Required