Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

appSuiteName

appSuiteName: 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.

compartmentId

compartmentId: string

The OCID of the compartment that contains the sensitive data model.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the sensitive data model.

displayName

displayName: string

The display name of the sensitive data model.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the sensitive data model.

isAppDefinedRelationDiscoveryEnabled

isAppDefinedRelationDiscoveryEnabled: boolean

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.

isIncludeAllSchemas

isIncludeAllSchemas: boolean

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).

isIncludeAllSensitiveTypes

isIncludeAllSensitiveTypes: boolean

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.

isSampleDataCollectionEnabled

isSampleDataCollectionEnabled: boolean

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.

lifecycleState

lifecycleState: DiscoveryLifecycleState

The current state of the sensitive data model.

Optional schemasForDiscovery

schemasForDiscovery: Array<string>

The schemas to be scanned by data discovery jobs.

Optional sensitiveTypeIdsForDiscovery

sensitiveTypeIdsForDiscovery: Array<string>

The OCIDs of the sensitive types to be used by data discovery jobs.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

targetId

targetId: 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.

timeCreated

timeCreated: Date

The date and time the sensitive data model was created, in the format defined by RFC3339.

timeUpdated

timeUpdated: Date

The date and time the sensitive data model was last updated, in the format defined by RFC3339.

Functions

getDeserializedJsonObj

getJsonObj