Oracle Data Safe API
The dataSafe API from Oracle — 258 operation(s) for datasafe.
Oracle Data Safe API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 369 operations across 258 paths, and defines 455 schemas. It is described by OpenAPI 3.2.0, at version 20181201.
Requests are made against 2 base URLs: http://127.0.0.1/20181201, https://127.0.0.1/20181201.
369 operations
258 paths
455 schemas
37 DELETE157 GET10 PATCH128 POST37 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 369
Across 258 paths, the API surfaces 369 operations — 37 DELETE, 157 GET, 10 PATCH, 128 POST, 37 PUT. Each is listed below with its method, path, parameters, and response codes.
dataSafe 369
POST
/actions/downloadPrivilegeScript
Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.
GET
/alertAnalytics
Returns the aggregation details of the alerts.
GET
/alertPolicies
Gets a list of all alert policies.
GET
/alertPolicies/{alertPolicyId}
Gets the details of the specified alert policy.
GET
/alertPolicies/{alertPolicyId}/rules
Lists the rules of the specified alert policy.
GET
/alerts
Gets a list of all alerts.
PATCH
/alerts
Patch alerts.
POST
/alerts/actions/updateAll
Updates alerts in the specified compartment.
GET
/alerts/{alertId}
Gets the details of the specified alerts.
PUT
/alerts/{alertId}
Updates the status of the specified alert.
POST
/alerts/{alertId}/actions/changeCompartment
Moves the specified alert into a different compartment.
GET
/attributeSets
Returns the list of attribute sets.
POST
/attributeSets
Creates an attribute set.
DELETE
/attributeSets/{attributeSetId}
Submits a work request to delete an attribute set.
GET
/attributeSets/{attributeSetId}
Gets the details of the specified attribute set.
PUT
/attributeSets/{attributeSetId}
Updates an attribute set.
POST
/attributeSets/{attributeSetId}/actions/changeCompartment
Moves the attribute set to the specified compartment.
GET
/attributeSets/{attributeSetId}/associatedResources
Returns list of all associated resources of the attribute set identified by the attribute set id passed as path parameter.
GET
/auditArchiveRetrievals
Returns the list of audit archive retrieval.
POST
/auditArchiveRetrievals
Creates a work request to retrieve archived audit data.
DELETE
/auditArchiveRetrievals/{auditArchiveRetrievalId}
Submits a work request to unload retrieved archive data.
GET
/auditArchiveRetrievals/{auditArchiveRetrievalId}
Gets the details of the specified archive retreival.
PUT
/auditArchiveRetrievals/{auditArchiveRetrievalId}
Updates the audit archive retrieval.
POST
/auditArchiveRetrievals/{auditArchiveRetrievalId}/actions/changeCompartment
Moves the archive retreival to the specified compartment.
GET
/auditEventAnalytics
Gets summary of Data Safe audit events by time trends, target name, user name, client hostname and object type.
GET
/auditEvents
Gets a list of Data Safe audit Events collected from the target database.
GET
/auditPolicies
Retrieves a list of all audit policies.
GET
/auditPolicies/{auditPolicyId}
Gets a audit policy by identifier.
PUT
/auditPolicies/{auditPolicyId}
Updates the audit policy.
POST
/auditPolicies/{auditPolicyId}/actions/changeCompartment
Moves the specified audit policy and its dependent resources into a different compartment.
POST
/auditPolicies/{auditPolicyId}/actions/provision
Provision audit policy.
POST
/auditPolicies/{auditPolicyId}/actions/retrieveFromTarget
Retrieves the audit policy details from the source target database.
GET
/auditPolicyAnalytics
Summarizes the audit policy information.
GET
/auditProfileAnalytics
Summarizes audit profile information.
GET
/auditProfiles
Gets a list of all audit profiles.
POST
/auditProfiles
Create a new audit profile resource.
DELETE
/auditProfiles/{auditProfileId}
Deletes the specified audit profile .
GET
/auditProfiles/{auditProfileId}
Get the details of audit profile.
PUT
/auditProfiles/{auditProfileId}
Updates one or more attributes of the specified audit profile.
POST
/auditProfiles/{auditProfileId}/actions/calculateAuditVolumeAvailable
Calculates the audit data volume available on target.
POST
/auditProfiles/{auditProfileId}/actions/calculateAuditVolumeCollected
Calculates the audit data collected by data safe.
POST
/auditProfiles/{auditProfileId}/actions/changeCompartment
Moves the specified audit profile and its dependent resources into a different compartment.
POST
/auditProfiles/{auditProfileId}/actions/changeRetention
Change the online and offline months .
POST
/auditProfiles/{auditProfileId}/actions/discoverAuditTrails
Updates the list of audit trails created under audit profile.
GET
/auditProfiles/{auditProfileId}/availableAuditVolumes
Gets a list of all data points for the audit volume available on target database.
GET
/auditProfiles/{auditProfileId}/collectedAuditVolumes
Gets a list of all collected audit volume data points.
GET
/auditProfiles/{auditProfileId}/targetOverrides
Gets a list of targets with their audit profiles and retention settings that override the target group setting.
GET
/auditTrailAnalytics
Summarizes audit trail information.
GET
/auditTrails
Gets a list of all audit trails.
DELETE
/auditTrails/{auditTrailId}
Deletes the specified audit trail .
GET
/auditTrails/{auditTrailId}
Get the details of audit trail.
PUT
/auditTrails/{auditTrailId}
Updates one or more attributes of the specified audit trail.
POST
/auditTrails/{auditTrailId}/actions/resume
Resumes the specified audit trail once it got stopped.
POST
/auditTrails/{auditTrailId}/actions/start
Starts collection of audit records on the specified audit trail.
POST
/auditTrails/{auditTrailId}/actions/stop
Stops the specified audit trail.
GET
/compatibleFormatsForDataTypes
Gets a list of basic masking formats compatible with the supported data types.
GET
/compatibleFormatsForSensitiveTypes
Gets a list of library masking formats compatible with the existing sensitive types.
GET
/configuration
Gets the details of the Data Safe configuration.
PUT
/configuration
Enables Data Safe in the tenancy and region.
POST
/configuration/{compartmentId}/actions/modifyGlobalSettings
Modifies Global Settings in Data Safe in the tenancy and region.
GET
/dataSafePrivateEndpoints
Gets a list of Data Safe private endpoints.
POST
/dataSafePrivateEndpoints
Creates a new Data Safe private endpoint.
DELETE
/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}
Deletes the specified Data Safe private endpoint.
GET
/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}
Gets the details of the specified Data Safe private endpoint.
PUT
/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}
Updates one or more attributes of the specified Data Safe private endpoint.
POST
/dataSafePrivateEndpoints/{dataSafePrivateEndpointId}/actions/changeCompartment
Moves the Data Safe private endpoint and its dependent resources to the specified compartment.
GET
/databaseSecurityConfigs
Retrieves a list of all database security configurations.
GET
/databaseSecurityConfigs/{databaseSecurityConfigId}
Gets a database security configuration by identifier.
PUT
/databaseSecurityConfigs/{databaseSecurityConfigId}
Updates the database security configuration.
POST
/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/changeCompartment
Moves the specified database security configuration and its dependent resources into a different compartment.
POST
/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/refresh
Refreshes the specified database security configuration.
GET
/discoveryAnalytics
Gets consolidated discovery analytics data based on the specified query parameters.
GET
/discoveryJobs
Gets a list of incremental discovery jobs based on the specified query parameters.
POST
/discoveryJobs
Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model.
DELETE
/discoveryJobs/{discoveryJobId}
Deletes the specified discovery job.
GET
/discoveryJobs/{discoveryJobId}
Gets the details of the specified discovery job.
POST
/discoveryJobs/{discoveryJobId}/actions/changeCompartment
Moves the specified discovery job and its dependent resources into a different compartment.
GET
/discoveryJobs/{discoveryJobId}/results
Gets a list of discovery results based on the specified query parameters.
PATCH
/discoveryJobs/{discoveryJobId}/results
Patches one or more discovery results.
DELETE
/discoveryJobs/{discoveryJobId}/results/{resultKey}
Deletes the specified discovery result.
GET
/discoveryJobs/{discoveryJobId}/results/{resultKey}
Gets the details of the specified discovery result.
GET
/libraryMaskingFormats
Gets a list of library masking formats based on the specified query parameters.
POST
/libraryMaskingFormats
Creates a new library masking format.
DELETE
/libraryMaskingFormats/{libraryMaskingFormatId}
Deletes the specified library masking format.
GET
/libraryMaskingFormats/{libraryMaskingFormatId}
Gets the details of the specified library masking format.
PUT
/libraryMaskingFormats/{libraryMaskingFormatId}
Updates one or more attributes of the specified library masking format.
POST
/libraryMaskingFormats/{libraryMaskingFormatId}/actions/changeCompartment
Moves the specified library masking format into a different compartment.
GET
/maskingAnalytics
Gets consolidated masking analytics data based on the specified query parameters.
GET
/maskingPolicies
Gets a list of masking policies based on the specified query parameters.
POST
/maskingPolicies
Creates a new masking policy.
DELETE
/maskingPolicies/{maskingPolicyId}
Deletes the specified masking policy.
GET
/maskingPolicies/{maskingPolicyId}
Gets the details of the specified masking policy.
PUT
/maskingPolicies/{maskingPolicyId}
Updates one or more attributes of the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/actions/addMaskingColumnsFromSdm
Adds columns to the specified masking policy from the associated sensitive data model.
POST
/maskingPolicies/{maskingPolicyId}/actions/changeCompartment
Moves the specified masking policy and its dependent resources into a different compartment.
POST
/maskingPolicies/{maskingPolicyId}/actions/download
Downloads an already-generated file corresponding to the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/actions/downloadLog
Downloads masking log.
POST
/maskingPolicies/{maskingPolicyId}/actions/downloadReport
Downloads an already-generated masking report.
POST
/maskingPolicies/{maskingPolicyId}/actions/generateHealthReport
Performs health check.
POST
/maskingPolicies/{maskingPolicyId}/actions/generatePolicyForDownload
Generates a downloadable file corresponding to the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/actions/generateReportForDownload
Generates a downloadable masking report.
POST
/maskingPolicies/{maskingPolicyId}/actions/mask
Masks data using the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/actions/upload
Uploads a masking policy file to update the specified masking policy.
GET
/maskingPolicies/{maskingPolicyId}/maskingColumns
Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.
PATCH
/maskingPolicies/{maskingPolicyId}/maskingColumns
Patches one or more columns in the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/maskingColumns
Creates a new masking column in the specified masking policy.
POST
/maskingPolicies/{maskingPolicyId}/maskingColumns/actions/applyDifferenceToMaskingColumns
Applies the difference of a SDM Masking policy difference resource to the specified masking policy.
DELETE
/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}
Deletes the specified masking column.
GET
/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}
Gets the details of the specified masking column.
PUT
/maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}
Updates one or more attributes of the specified masking column.
GET
/maskingPolicies/{maskingPolicyId}/maskingObjects
Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.
GET
/maskingPolicies/{maskingPolicyId}/maskingSchemas
Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.
GET
/maskingPolicies/{maskingPolicyId}/referentialRelations
Gets a list of referential relations present in the specified masking policy based on the specified query parameters.
GET
/maskingPolicyHealthReports
Gets a list of masking policy health reports based on the specified query parameters.
DELETE
/maskingPolicyHealthReports/{maskingPolicyHealthReportId}
Deletes the specified masking policy health report.
GET
/maskingPolicyHealthReports/{maskingPolicyHealthReportId}
Gets the details of the specified masking policy health report.
POST
/maskingPolicyHealthReports/{maskingPolicyHealthReportId}/actions/changeCompartment
Moves the specified masking policy health report and its dependent resources into a different compartment.
GET
/maskingPolicyHealthReports/{maskingPolicyHealthReportId}/logs
Gets a list of errors and warnings from a masking policy health check.
GET
/maskingReports
Gets a list of masking reports based on the specified query parameters.
DELETE
/maskingReports/{maskingReportId}
Deletes the specified masking report.
GET
/maskingReports/{maskingReportId}
Gets the details of the specified masking report.
GET
/maskingReports/{maskingReportId}/maskedColumns
Gets a list of masked columns present in the specified masking report and based on the specified query parameters.
GET
/maskingReports/{maskingReportId}/maskingErrors
Gets a list of masking errors in a masking run based on the specified query parameters.
GET
/onPremConnectors
Gets a list of on-premises connectors.
POST
/onPremConnectors
Creates a new on-premises connector.
DELETE
/onPremConnectors/{onPremConnectorId}
Deletes the specified on-premises connector.
GET
/onPremConnectors/{onPremConnectorId}
Gets the details of the specified on-premises connector.
PUT
/onPremConnectors/{onPremConnectorId}
Updates one or more attributes of the specified on-premises connector.
POST
/onPremConnectors/{onPremConnectorId}/actions/changeCompartment
Moves the specified on-premises connector into a different compartment.
POST
/onPremConnectors/{onPremConnectorId}/actions/generateConfiguration
Creates and downloads the configuration of the specified on-premises connector.
PUT
/onPremConnectors/{onPremConnectorId}/wallet
Updates the wallet of the specified on-premises connector to a new version.
GET
/registrationPolicies
Retrieves the list of Registration Policies according to the specified query parameters.
POST
/registrationPolicies
Creates a new OptIn/Registration Policy
DELETE
/registrationPolicies/{registrationPolicyId}
Deletes the specified registration policy.
GET
/registrationPolicies/{registrationPolicyId}
Returns the details of the specified Registration Policy.
PUT
/registrationPolicies/{registrationPolicyId}
Updates one or more attributes of the specified registration policy.
POST
/registrationPolicies/{registrationPolicyId}/actions/changeCompartment
Moves the registration policy to the specified compartment.
GET
/reportDefinitions
Gets a list of report definitions. The report definitions can be seeded or user created.
POST
/reportDefinitions
Creates a new report definition
DELETE
/reportDefinitions/{reportDefinitionId}
Deletes the specified report definition
GET
/reportDefinitions/{reportDefinitionId}
Gets details of the specified report definition
PUT
/reportDefinitions/{reportDefinitionId}
Updates the specified report definition.
POST
/reportDefinitions/{reportDefinitionId}/actions/changeCompartment
Moves a resource into a different compartment.
POST
/reportDefinitions/{reportDefinitionId}/actions/generateReport
Generates a .xls or .pdf report.
POST
/reportDefinitions/{reportDefinitionId}/actions/removeScheduleReport
Deletes schedule of a .xls or .pdf report.
POST
/reportDefinitions/{reportDefinitionId}/actions/scheduleReport
Schedules a .xls or .pdf report.
GET
/reports
Gets a list of all the reports in the compartment.
GET
/reports/{reportId}
Gets the details of the specified report.
PUT
/reports/{reportId}
Updates the specified report.
POST
/reports/{reportId}/actions/changeCompartment
Moves a resource into a different compartment.
GET
/reports/{reportId}/content
Download the specified report.
GET
/sdmMaskingPolicyDifferences
Gets a list of SDM and masking policy difference resources based on the specified query parameters.
POST
/sdmMaskingPolicyDifferences
Creates SDM masking policy difference for the specified masking policy. It finds the difference between masking columns of the masking policy and sensitive columns of the SDM.
DELETE
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}
Deletes the specified SDM Masking policy difference.
GET
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}
Gets the details of the specified SDM Masking policy difference.
PUT
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}
Updates one or more attributes of the specified sdm masking policy difference.
POST
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/actions/changeCompartment
Moves the specified SDM masking policy difference into a different compartment.
GET
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns
Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.
PATCH
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns
Patches one or more SDM masking policy difference columns.
GET
/sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns/{differenceColumnKey}
Gets the details of the specified SDM Masking policy difference column.
GET
/securityAssessments
Gets a list of security assessments. Security assessments can be of type: LATEST, SAVED, SAVESCHEDULE, TEMPLATE, TEMPLATEBASELINE or COMPARTMENT. When using COMPARTMENT type, the list of all security…
POST
/securityAssessments
Creates a new saved security assessment.
GET
/securityAssessments/findingAnalytics
Gets a list of findings aggregated details in the specified compartment.
GET
/securityAssessments/securityFeatureAnalytics
Gets a list of Database security feature usage aggregated details in the specific compartment.
GET
/securityAssessments/securityFeatures
Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.
GET
/securityAssessments/templateAnalytics
Gets a list of template aggregated details in the specific compartment.
GET
/securityAssessments/templateAssociationAnalytics
Gets a list of template association details in the specific compartment.
DELETE
/securityAssessments/{securityAssessmentId}
Deletes the specified security assessment.
GET
/securityAssessments/{securityAssessmentId}
Gets the details of the specified security assessment.
PUT
/securityAssessments/{securityAssessmentId}
Updates one or more attributes of the specified security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/applyTemplate
Apply the checks from the template to the specified security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/changeCompartment
Moves the specified saved security assessment or future scheduled assessments into a different compartment.
POST
/securityAssessments/{securityAssessmentId}/actions/compare
Compares security assessments.
POST
/securityAssessments/{securityAssessmentId}/actions/compareToTemplateBaseline
Compares latest target-group security assessment to template-baseline security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/downloadReport
Downloads the report of the specified security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/generateReport
Generates the report of the specified security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/refresh
Runs a security assessment, updates the latest assessment, and saves it for future reference.
POST
/securityAssessments/{securityAssessmentId}/actions/removeTemplate
Remove the checks from the template to the specified security assessment.
POST
/securityAssessments/{securityAssessmentId}/actions/setBaseline
Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides.
POST
/securityAssessments/{securityAssessmentId}/actions/unsetBaseline
Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline.
GET
/securityAssessments/{securityAssessmentId}/checks
Lists all the security checks in the specified compartment for security assessment of type TEMPLATE.
PATCH
/securityAssessments/{securityAssessmentId}/checks
Patches one or more checks in the specified security assessment.
GET
/securityAssessments/{securityAssessmentId}/comparison/{comparisonSecurityAssessmentId}
Gets the details of the comparison report for the provided security assessments.
GET
/securityAssessments/{securityAssessmentId}/findings
Lists all the findings for the specified assessment except for type TEMPLATE. If the assessment is of type TEMPLATEBASELINE, the findings returned are the security checks with the user-defined severi…
PATCH
/securityAssessments/{securityAssessmentId}/findings
Patches one or more findings in the specified security assessment.
PUT
/securityAssessments/{securityAssessmentId}/findings/{findingKey}
Updates one or more attributes of the specified finding.
GET
/securityAssessments/{securityAssessmentId}/findingsChangeAuditLogs
List all risk level changes made by user for findings for the specified assessment.
GET
/securityAssessments/{securityAssessmentId}/templateBaselineComparison/{comparisonSecurityAssessmentId}
Gets the details of the comparison report for the provided security assessments.
GET
/securityPolicies
Retrieves a list of all security policies.
POST
/securityPolicies
Creates a security policy.
DELETE
/securityPolicies/{securityPolicyId}
Deletes the specified security policy.
GET
/securityPolicies/{securityPolicyId}
Gets a security policy by the specified OCID of the security policy resource.
PUT
/securityPolicies/{securityPolicyId}
Updates the security policy.
POST
/securityPolicies/{securityPolicyId}/actions/changeCompartment
Moves the specified security policy and its dependent resources into a different compartment.
GET
/securityPolicyConfigs
Retrieves a list of all security policy configurations.
POST
/securityPolicyConfigs
Creates a new security policy configuration resource.
DELETE
/securityPolicyConfigs/{securityPolicyConfigId}
Deletes the specified Security policy configuration.
GET
/securityPolicyConfigs/{securityPolicyConfigId}
Gets a security policy configuration by identifier.
PUT
/securityPolicyConfigs/{securityPolicyConfigId}
Updates the security policy configuration.
POST
/securityPolicyConfigs/{securityPolicyConfigId}/actions/changeCompartment
Moves the specified security policy configuration and its dependent resources into a different compartment.
GET
/securityPolicyDeployments
Retrieves a list of all security policy deployments.
POST
/securityPolicyDeployments
Creates a security policy deployment in the Data Safe Console.
DELETE
/securityPolicyDeployments/{securityPolicyDeploymentId}
Deletes the specified Security policy deployment.
GET
/securityPolicyDeployments/{securityPolicyDeploymentId}
Gets a security policy deployment by identifier.
PUT
/securityPolicyDeployments/{securityPolicyDeploymentId}
Updates the security policy deployment.
POST
/securityPolicyDeployments/{securityPolicyDeploymentId}/actions/changeCompartment
Moves the specified security policy deployment and its dependent resources into a different compartment.
POST
/securityPolicyDeployments/{securityPolicyDeploymentId}/actions/deploy
Deploy the security policy.
POST
/securityPolicyDeployments/{securityPolicyDeploymentId}/actions/refresh
Refresh the security policy deployment.
GET
/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates
Retrieves a list of all security policy entry states.
GET
/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates/{securityPolicyEntryStateId}
Gets a security policy entity states by identifier.
GET
/securityPolicyReports
Retrieves a list of all security policy reports.
GET
/securityPolicyReports/{securityPolicyReportId}
Gets a security policy report by the specified OCID of the security policy report resource.
GET
/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries
Retrieves a list of all database table access entries.
GET
/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries/{databaseTableAccessEntryKey}
Gets a database table access entry object by identifier.
GET
/securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries
Retrieves a list of all database view access objects.
GET
/securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries/{databaseViewAccessEntryKey}
Gets a database view access object by identifier.
GET
/securityPolicyReports/{securityPolicyReportId}/roleGrantPaths
Retrieves a list of all role grant paths for a user.
GET
/sensitiveColumnAnalytics
Gets consolidated sensitive column analytics data based on the specified query parameters.
GET
/sensitiveDataModels
Gets the list of sensitive data models.
POST
/sensitiveDataModels
Creates a new sensitive data model.
DELETE
/sensitiveDataModels/{sensitiveDataModelId}
Deletes the specified sensitive data model.
GET
/sensitiveDataModels/{sensitiveDataModelId}
Gets the details of the specified sensitive data model.
PUT
/sensitiveDataModels/{sensitiveDataModelId}
Updates one or more attributes of the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/changeCompartment
Moves the specified sensitive data model and its dependent resources into a different compartment.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/download
Downloads an already-generated file corresponding to the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/downloadReport
Downloads an already-generated discovery report for the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/generateDataModelForDownload
Generates a downloadable file corresponding to the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/generateReportForDownload
Generates a downloadable discovery report.
POST
/sensitiveDataModels/{sensitiveDataModelId}/actions/upload
Uploads a sensitive data model file to update the specified sensitive data model.
GET
/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations
Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters.
POST
/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations
Creates a new referential relation in the specified sensitive data model.
DELETE
/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}
Deletes the specified referential relation.
GET
/sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}
Gets the details of the specified referential relation.
GET
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns
Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.
PATCH
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns
Patches one or more columns in the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns
Creates a new sensitive column in the specified sensitive data model.
POST
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/actions/applyDiscoveryJobResults
Applies the results of a discovery job to the specified sensitive data model.
DELETE
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}
Deletes the specified sensitive column.
GET
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}
Gets the details of the specified sensitive column.
PUT
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}
Updates one or more attributes of the specified sensitive column.
GET
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveObjects
Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.
GET
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas
Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.
GET
/sensitiveDataModels/{sensitiveDataModelId}/sensitiveTypes
Gets a list of sensitive type Ids present in the specified sensitive data model.
GET
/sensitiveTypeGroups
Gets a list of sensitive type groups based on the specified query parameters.
POST
/sensitiveTypeGroups
Creates a new sensitive type group.
DELETE
/sensitiveTypeGroups/{sensitiveTypeGroupId}
Deletes the specified sensitive type group.
GET
/sensitiveTypeGroups/{sensitiveTypeGroupId}
Gets the details of the specified sensitive type group.
PUT
/sensitiveTypeGroups/{sensitiveTypeGroupId}
Updates one or more attributes of the specified sensitive type group.
POST
/sensitiveTypeGroups/{sensitiveTypeGroupId}/actions/changeCompartment
Moves the sensitive type group to the specified compartment.
GET
/sensitiveTypeGroups/{sensitiveTypeGroupId}/groupedSensitiveTypes
Sensitive types for the specified sensitive type group retrieved successfully.
PATCH
/sensitiveTypeGroups/{sensitiveTypeGroupId}/groupedSensitiveTypes
Patches one or more sensitive types in a sensitive type group.
GET
/sensitiveTypes
Gets a list of sensitive types based on the specified query parameters.
POST
/sensitiveTypes
Creates a new sensitive type.
POST
/sensitiveTypes/actions/bulkCreateSensitiveTypes
Uploads a sensitive types xml file to create new sensitive types in regions.
DELETE
/sensitiveTypes/{sensitiveTypeId}
Deletes the specified sensitive type.
GET
/sensitiveTypes/{sensitiveTypeId}
Gets the details of the specified sensitive type.
PUT
/sensitiveTypes/{sensitiveTypeId}
Updates one or more attributes of the specified sensitive type.
POST
/sensitiveTypes/{sensitiveTypeId}/actions/changeCompartment
Moves the specified sensitive type into a different compartment.
GET
/sensitiveTypesExports
Retrieves a list of all sensitive types export based on the specified query parameters.
POST
/sensitiveTypesExports
Generates a downloadable file corresponding to the specified list of sensitive types.
DELETE
/sensitiveTypesExports/{sensitiveTypesExportId}
Deletes the specified sensitive types export.
GET
/sensitiveTypesExports/{sensitiveTypesExportId}
Gets the details of the specified sensitive types export by identifier.
PUT
/sensitiveTypesExports/{sensitiveTypesExportId}
Updates one or more attributes of the specified sensitive types export.
POST
/sensitiveTypesExports/{sensitiveTypesExportId}/actions/changeCompartment
Moves the specified sensitive types export into a different compartment.
POST
/sensitiveTypesExports/{sensitiveTypesExportId}/actions/download
Downloads an already-generated file corresponding to the specified sensitive types export
GET
/sqlCollectionAnalytics
Retrieves a list of all SQL collections.
GET
/sqlCollections
Retrieves a list of all SQL collections.
POST
/sqlCollections
Creates a new SQL collection resource.
DELETE
/sqlCollections/{sqlCollectionId}
Deletes the specified SQL collection.
GET
/sqlCollections/{sqlCollectionId}
Gets a SQL collection by identifier.
PUT
/sqlCollections/{sqlCollectionId}
Updates the SQL collection.
POST
/sqlCollections/{sqlCollectionId}/actions/changeCompartment
Moves the specified SQL collection and its dependent resources into a different compartment.
POST
/sqlCollections/{sqlCollectionId}/actions/generateSqlFirewallPolicy
Generates or appends to the SQL Firewall policy using the specified SQL collection.
POST
/sqlCollections/{sqlCollectionId}/actions/purgeLogs
Purge the SQL collection logs for the specified SqlCollection.
POST
/sqlCollections/{sqlCollectionId}/actions/refreshLogInsights
Refresh the specified SQL collection Log Insights.
POST
/sqlCollections/{sqlCollectionId}/actions/start
Starts the specified SQL collection.
POST
/sqlCollections/{sqlCollectionId}/actions/stop
Stops the specified SQL collection.
GET
/sqlCollections/{sqlCollectionId}/logInsights
Retrieves a list of all SQL collections.
GET
/sqlFirewallAllowedSqlAnalytics
Returns the aggregation details of all SQL Firewall allowed SQL statements.
GET
/sqlFirewallAllowedSqls
Retrieves a list of all SQL Firewall allowed SQL statements.
PATCH
/sqlFirewallAllowedSqls
Delete multiple allowed sqls.
POST
/sqlFirewallAllowedSqls/actions/bulkCreate
Appends the allowedSqls with entries from the logs.
POST
/sqlFirewallAllowedSqls/actions/bulkDelete
Delete multiple allowed sqls.
DELETE
/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}
Deletes the specified allowed sql.
GET
/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}
Gets a SQL firewall allowed SQL by identifier.
GET
/sqlFirewallPolicies
Retrieves a list of all SQL Firewall policies.
DELETE
/sqlFirewallPolicies/{sqlFirewallPolicyId}
Deletes the SQL Firewall policy.
GET
/sqlFirewallPolicies/{sqlFirewallPolicyId}
Gets a SQL Firewall policy by identifier.
PUT
/sqlFirewallPolicies/{sqlFirewallPolicyId}
Updates the SQL Firewall policy.
POST
/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment
Moves the specified SQL Firewall policy and its dependent resources into a different compartment.
GET
/sqlFirewallPolicyAnalytics
Summarizes the SQL Firewall policy information.
GET
/sqlFirewallViolationAnalytics
Returns the aggregation details of the SQL Firewall violations.
GET
/sqlFirewallViolations
Gets a list of all the SQL Firewall violations captured by the firewall.
GET
/targetAlertPolicyAssociations
Gets a list of all target-alert policy associations.
PATCH
/targetAlertPolicyAssociations
Creates new target-alert policy associations that will be applied on the target database.
POST
/targetAlertPolicyAssociations
Creates a new target-alert policy association to track a alert policy applied on target.
DELETE
/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}
Deletes the specified target-alert policy Association.
GET
/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}
Gets the details of the specified target-alert policy association.
PUT
/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}
Updates the specified target-alert policy association.
POST
/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment
Moves the specified target-alert policy association into a different compartment.
GET
/targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/unassociatedTargetMembers
Gets the details of the specified target-alert policy association and its unassociated members.
GET
/targetDatabaseGroups
Retrieves a list of target database groups according to the specified query parameters.
POST
/targetDatabaseGroups
Creates a new target database group.
DELETE
/targetDatabaseGroups/{targetDatabaseGroupId}
Deletes the specified target database group.
GET
/targetDatabaseGroups/{targetDatabaseGroupId}
Returns the details of the specified target database group.
PUT
/targetDatabaseGroups/{targetDatabaseGroupId}
Updates one or more attributes of the specified target database group.
POST
/targetDatabaseGroups/{targetDatabaseGroupId}/actions/changeCompartment
Moves the target database group to the specified compartment.
GET
/targetDatabaseGroups/{targetDatabaseGroupId}/groupMembers
Retrieves the members of the target database group with the specified OCID.
GET
/targetDatabases
Returns the list of registered target databases in Data Safe.
POST
/targetDatabases
Registers the specified database with Data Safe and creates a target database in the Data Safe Console.
DELETE
/targetDatabases/{targetDatabaseId}
Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.
GET
/targetDatabases/{targetDatabaseId}
Returns the details of the specified Data Safe target database.
PUT
/targetDatabases/{targetDatabaseId}
Updates one or more attributes of the specified Data Safe target database.
POST
/targetDatabases/{targetDatabaseId}/actions/activate
Reactivates a previously deactivated Data Safe target database.
POST
/targetDatabases/{targetDatabaseId}/actions/changeCompartment
Moves the Data Safe target database to the specified compartment.
POST
/targetDatabases/{targetDatabaseId}/actions/deactivate
Deactivates a target database in Data Safe.
POST
/targetDatabases/{targetDatabaseId}/actions/managePrivileges
Updates the Data Safe target database Privileges.
POST
/targetDatabases/{targetDatabaseId}/actions/refresh
Refreshes the Data Safe target database to update it's state.
POST
/targetDatabases/{targetDatabaseId}/actions/refreshDictionaryObjects
Refresh dictionary data for the Data Safe target database.
GET
/targetDatabases/{targetDatabaseId}/columns
List metadata of columns from all the tables in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter.
GET
/targetDatabases/{targetDatabaseId}/dictionary
Gets the date and time the dictionary objects were last fetched from the database. The target database is identified by id supplied as a path parameter.
GET
/targetDatabases/{targetDatabaseId}/peerTargetDatabases
Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.
POST
/targetDatabases/{targetDatabaseId}/peerTargetDatabases
Creates the peer target database under the primary target database in Data Safe.
DELETE
/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}
Removes the specified peer target database from Data Safe.
GET
/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}
Returns the details of the specified Data Safe peer target database.
PUT
/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}
Updates one or more attributes of the specified Data Safe peer target database.
GET
/targetDatabases/{targetDatabaseId}/roles
List metadata of roles in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter.
GET
/targetDatabases/{targetDatabaseId}/schemas
List metadata of schema present in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter.
GET
/targetDatabases/{targetDatabaseId}/tables
List metadata of tables in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter.
GET
/unifiedAuditPolicies
Retrieves a list of all Unified Audit policies.
POST
/unifiedAuditPolicies
Creates the specified unified audit policy.
POST
/unifiedAuditPolicies/actions/bulkCreate
Bulk create unified audit policies.
DELETE
/unifiedAuditPolicies/{unifiedAuditPolicyId}
Deletes the Unified Audit policy.
GET
/unifiedAuditPolicies/{unifiedAuditPolicyId}
Gets a Unified Audit policy by identifier.
PUT
/unifiedAuditPolicies/{unifiedAuditPolicyId}
Updates the Unified Audit policy.
POST
/unifiedAuditPolicies/{unifiedAuditPolicyId}/actions/changeCompartment
Moves the specified Unified Audit policy and its dependent resources into a different compartment.
GET
/unifiedAuditPolicyDefinitions
Retrieves a list of all unified audit policy definitions.
DELETE
/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}
Deletes the specified Unified audit policy definition.
GET
/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}
Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource.
PUT
/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}
Updates the unified audit policy definition.
POST
/unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}/actions/changeCompartment
Moves the specified unified audit policy definition and its dependent resources into a different compartment.
GET
/userAssessments
Gets a list of user assessments. User assessments can be of type: LATEST, SAVED, SAVESCHEDULE, or COMPARTMENT. When using COMPARTMENT type, statistical information across all compartments is returned…
POST
/userAssessments
Creates a new saved user assessment.
DELETE
/userAssessments/{userAssessmentId}
Deletes the specified saved user assessment.
GET
/userAssessments/{userAssessmentId}
Gets the details of the specified user assessment.
PUT
/userAssessments/{userAssessmentId}
Updates one or more attributes of the specified user assessment.
POST
/userAssessments/{userAssessmentId}/actions/changeCompartment
Moves the specified saved user assessment or future scheduled assessments into a different compartment.
POST
/userAssessments/{userAssessmentId}/actions/compare
Compares user assessments.
POST
/userAssessments/{userAssessmentId}/actions/downloadReport
Downloads the report of the specified user assessment.
POST
/userAssessments/{userAssessmentId}/actions/generateReport
Generates the report of the specified user assessment.
POST
/userAssessments/{userAssessmentId}/actions/refresh
Runs a user assessment, updates the latest assessment, and saves it for future reference.
POST
/userAssessments/{userAssessmentId}/actions/setBaseline
Sets the saved user assessment as the baseline in the compartment where the specified assessment resides.
POST
/userAssessments/{userAssessmentId}/actions/unsetBaseline
Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline.
GET
/userAssessments/{userAssessmentId}/comparison/{comparisonUserAssessmentId}
Gets the details of the comparison report for the provided user assessments.
GET
/userAssessments/{userAssessmentId}/passwordExpiryDateAnalytics
Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days and beyond 90 days based on specified user assessment.
GET
/userAssessments/{userAssessmentId}/profileAnalytics
Gets a list of user profile aggregated details in the specified compartment.
GET
/userAssessments/{userAssessmentId}/profiles
Gets a list of user profiles available on a given or all the target(s) using user assessment id in a given compartment.
GET
/userAssessments/{userAssessmentId}/profiles/{profileName}
Details of given profile available on given target.
GET
/userAssessments/{userAssessmentId}/userAccessAnalytics
Gets a list of user access aggregated details of the specified user assessment.
GET
/userAssessments/{userAssessmentId}/userAnalytics
Gets a list of user aggregated details of the specified user assessment.
GET
/userAssessments/{userAssessmentId}/users
Gets a list of users of the specified user assessment. The result contains database user details such as user type, account status, last login time, user creation time, authentication type, user prof…
GET
/userAssessments/{userAssessmentId}/users/{userKey}/grants
Gets a list of grants for a particular user in the specified user assessment.
GET
/workRequests
Gets a list of work requests.
DELETE
/workRequests/{workRequestId}
Cancel the specified work request.
GET
/workRequests/{workRequestId}
Gets the details of the specified work request.
POST
/workRequests/{workRequestId}/actions/resume
Resume the given work request.
POST
/workRequests/{workRequestId}/actions/suspend
Suspend the given work request.
GET
/workRequests/{workRequestId}/errors
Gets a list of errors for the specified work request.
GET
/workRequests/{workRequestId}/logs
Gets a list of log entries for the specified work request.
Schemas 455
The contract defines 455 schemas that model the data the API accepts and returns. The most detailed are AuditEventSummary (41 properties), SecurityAssessment (30 properties), ReportDefinition (29 properties), Profile (27 properties). Each schema is shown below with its type and property counts.
ReferentialRelationSummary
object
A referential relation is a resource corresponding to a database columns. It's a subresource of sensitive data model resource and is always associated with a s…
7 properties
6 required
AuditArchiveRetrievalSummary
object
Summary details of an archive retrieval.
16 properties
7 required
GrantSummary
object
The summary of user grants.
5 properties
1 required
SqlFirewallViolationSummary
object
The resource represents the SQL violations collected from the target database by Oracle Data Safe.
17 properties
7 required
LibraryMaskingFormatCollection
object
A collection of library masking format summary objects.
1 property
1 required
UserAssessment
object
The details of the user assessment, which includes statistics related to target database users.
25 properties
7 required
UpdateColumnSourceDetails
object
Details to update the column source of a masking policy.
1 property
1 required
UpdateMaskingPolicyDetails
object
Details to update a masking policy.
12 properties
SqlCollectionSummary
object
The resource represents SQL collection for a specific database user in a target. SqlCollection encapsulates the SQL commands issued in the user’s database sess…
16 properties
8 required
UserAssessmentComparison
object
Provides a list of differences for user assessment when compared with the baseline value.
3 properties
2 required
DatabaseViewAccessEntry
object
A DatabaseViewAccessEntry object is a resource corresponding to a row in view authorization report. It's a subresource of Security Policy Report resource and i…
20 properties
2 required
ProfileAggregation
object
The profile aggregation provides information about the user profiles available on the database. For example, the user profile details include how many users ha…
3 properties
1 required
AlertPolicyRuleCollection
object
Collection of alert policy rules summary.
1 property
1 required
EntryDetails
object
Details specific to the security policy entry.
1 property
1 required
OnPremConnectorSummary
object
Summary of a Data Safe on-premises connector.
11 properties
5 required
TargetAlertPolicyAssociation
object
The association of the target database to an alert policy.
14 properties
6 required
AuditTrailAggregationItems
object
Details of audit trail aggregation items.
2 properties
SecurityAssessmentBaseLineDetails
object
The details required to set the baseline for the assessment.
1 property
AttributeSetSummary
object
Summary details of an attribute set.
13 properties
6 required
ConnectionOption
object
Types of connection supported by Data Safe.
1 property
1 required
PatchMaskingColumnsDetails
object
Details to patch columns in a masking policy.
1 property
ChangeSqlFirewallPolicyCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
Check
object
The security rule to be evaluated by security assessment to create finding.
7 properties
1 required
SecurityFeatureAnalyticsCollection
object
The collection of database security feature analytics summary.
1 property
1 required
ChangeSdmMaskingPolicyDifferenceCompartmentDetails
object
Details to change the compartment of a SDM masking policy difference.
1 property
1 required
SectionStatistics
object
Statistics showing the number of findings with a particular risk level for each category.
8 properties
SecurityPolicyConfigSummary
object
The Data Safe resource represents the common configurations corresponding to the associated security policy.
14 properties
6 required
PeerTargetDatabase
object
The details of the peer target database in Data Safe.
11 properties
6 required
MaskingAnalyticsCollection
object
A collection of masking analytics summary objects.
1 property
1 required
MaskingAnalyticsDimensions
object
The scope of analytics data.
3 properties
CreateTargetDatabaseDetails
object
The details used to register the database in Data Safe and to create the Data Safe target database.
10 properties
2 required
CollectedAuditVolumeSummary
object
The volume data point for audit data collected by datasafe.
4 properties
4 required
SecurityPolicyEntryStateSummary
object
The resource represents the state of a specific entry type deployment on a target.
7 properties
5 required
AuditEventAggregationItems
object
The details of audit events aggregation items.
6 properties
4 required
columnSorting
object
Sorts the data at the column level.
3 properties
3 required
SqlCollectionDimensions
object
The dimensions available for SQL collection analytics.
2 properties
ChangeSecurityPolicyConfigCompartmentDetails
object
The details of the compartment to move the security policy configuration to.
1 property
1 required
DiscoveryAnalyticsCollection
object
A collection of discovery analytics summary objects.
1 property
1 required
ChangeAttributeSetCompartmentDetails
object
The compartment where the attribute set will move to.
1 property
1 required
UpdateSdmMaskingPolicyDifferenceDetails
object
Details to update a sdm masking policy difference.
3 properties
Credentials
object
The database credentials required for Data Safe to connect to the database.
2 properties
2 required
DownloadSensitiveTypesExportDetails
object
Details to download a sensitive types export.
1 property
MaskingPolicyHealthReportLogCollection
object
A collection of masking policy health log objects.
1 property
1 required
BulkCreateSqlFirewallAllowedSqlsDetails
object
The details used to append the violation logs as allowed SQLs
3 properties
3 required
GroupedSensitiveTypeSummary
object
Id of sensitive types present in a sensitive type group.
1 property
1 required
AuditPolicyDimensions
object
Details of aggregation dimensions used for summarizing audit policies.
3 properties
AuditPolicyCollection
object
Collection of audit policy summary.
1 property
1 required
SensitiveSchemaCollection
object
A collection of sensitive schema summary objects.
1 property
1 required
DownloadMaskingLogDetails
object
Details to download the masking log.
2 properties
SecurityFeatureSummary
object
The details of database security feature usage available on a given compartment.
16 properties
14 required
MaskedColumnCollection
object
A collection of masking column summary objects.
1 property
1 required
ChangeOnPremConnectorCompartmentDetails
object
The details used to change the compartment of a on-premises connector.
1 property
1 required
WorkRequestLogEntry
object
A log entry related to a work request.
2 properties
2 required
UpdateLibraryMaskingFormatDetails
object
Details to update a library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified…
6 properties
AuditPolicyAggregationItems
object
The details of the audit profile aggregation items.
2 properties
SensitiveColumnAnalyticsSummary
object
The details of sensitive column analytics data.
2 properties
2 required
SqlFirewallViolationAnalyticsCollection
object
SQL violations summarized detail.
1 property
1 required
ChangeUnifiedAuditPolicyDefinitionCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
SqlFirewallPolicy
object
The SQL Firewall policy resource contains the firewall policy metadata for a single user.
21 properties
8 required
ChangeRegistrationPolicyCompartmentDetails
object
The details required to move a registration policy to a different compartment. This object contains the OCID of the compartment to which the registration polic…
1 property
1 required
AuditProfile
object
The resource represents audit profile settings and audit configurations for the database target, and helps evaluate the initial audit data volume for configuri…
23 properties
11 required
UpdateUnifiedAuditPolicyDefinitionDetails
object
Details to update the audit policy.
4 properties
OnPremConnector
object
A Data Safe on-premises connector that enables Data Safe to connect to on-premises databases.
12 properties
5 required
ChangeSecurityPolicyDeploymentCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
DataSafePrivateEndpointSummary
object
Summary of a Data Safe private endpoint.
13 properties
6 required
CreateSqlCollectionDetails
object
Details for SQL collection creation.
9 properties
3 required
RegistrationPolicyCollection
object
A collection of registration policy summaries. This object contains an array of registration policy summary items.
1 property
1 required
MaskingPolicyReferentialRelationSummary
object
A referential relation is a resource corresponding to database columns. It is always associated with a masking policy.
5 properties
4 required
ProfileSummary
object
The summary of information about the user profiles. It includes details such as profile name, failed login attempts, sessions per user, inactive account time,…
13 properties
2 required
SqlCollectionAnalyticsCollection
object
SQL collection analytics collection.
1 property
1 required
TableSummary
object
The details of a table fetched from the database.
2 properties
2 required
WorkRequest
object
An asynchronous work request.
9 properties
7 required
GenerateOnPremConnectorConfigurationDetails
object
The details used to create and download on-premises connector's configuration.
1 property
1 required
SqlCollectionCollection
object
Collection of SQL collection summary.
1 property
1 required
DiscoveryJob
object
A data discovery job. It helps track job's metadata as well as result statistics.
26 properties
19 required
AlertSummary
object
Summary of a Data Safe Alert.
19 properties
8 required
AvailableAuditVolumeCollection
object
Collection of available audit volume summary.
1 property
1 required
PolicyCondition
object
The audit policy provisioning conditions.
3 properties
3 required
AlertAnalyticsCollection
object
The summarized detail of alerts aggregation.
1 property
1 required
ChangeDataSafePrivateEndpointCompartmentDetails
object
The details used to change the compartment of a Data Safe private endpoint.
1 property
ChangeAuditPolicyCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
CreateSensitiveTypeGroupDetails
object
The details to create a sensitive type group.
5 properties
1 required
DatabaseTableAccessEntry
object
A DatabaseTableAccess is a resource corresponding to a row in database table access report. It contains information about user's privilege grants that enable t…
22 properties
1 required
GenerateMaskingReportForDownloadDetails
object
Details to generate a downloadable masking report.
2 properties
2 required
AuditProfileAnalyticCollection
object
Details of audit profile analytic summary.
1 property
1 required
TemplateAssociationAnalyticsSummary
object
The summary of template association analytics data.
3 properties
2 required
CompareToTemplateBaselineDetails
object
Details specifying the security assessment used for comparison.
1 property
1 required
FindingsChangeAuditLogSummary
object
Summary of audit log of risk updates of findings of specified security assessment.
13 properties
12 required
GenerateSecurityAssessmentReportDetails
object
The details used to generate a new security assessment report.
2 properties
1 required
AuditProfileAggregationItems
object
Details of audit profile aggregation items.
2 properties
WorkRequestResource
object
A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
4 properties
3 required
UnifiedAuditPolicyDefinition
object
Resource represents a single unified audit policy definition.
15 properties
5 required
SqlCollection
object
The resource represents SQL collection for a specific database user in a target. SqlCollection encapsulates the SQL commands issued in the user’s database sess…
17 properties
8 required
TemplateAnalyticsSummary
object
The summary of template analytics data.
3 properties
2 required
CreateSensitiveDataModelDetails
object
Details to create a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns…
15 properties
2 required
UpdateReportDefinitionDetails
object
Description of a new report definition.
8 properties
5 required
SqlFirewallPolicyDimensions
object
The dimensions available for SQL Firewall policy analytics.
4 properties
SqlCollectionAggregation
object
The details of SQL collections.
2 properties
2 required
UnifiedAuditPolicy
object
Resource represents a single unified audit policy on the target database.
17 properties
5 required
ProvisionAuditPolicyDetails
object
Details for audit policy provisioning.
2 properties
1 required
CreateLibraryMaskingFormatDetails
object
Details to create a library masking format, which can have one or more format entries. A format entry can be a basic masking format such as Random Number, or i…
7 properties
2 required
UnifiedAuditPolicyDefinitionCollection
object
Collection of audit policy summary.
1 property
1 required
SensitiveTypesExportSummary
object
The resource represents collection of sensitive types needed to be exported.
9 properties
5 required
MaskingSchemaSummary
object
Summary of a masking schema present in masking policy.
1 property
1 required
DownloadSecurityAssessmentReportDetails
object
The details used to download a security assessment report.
2 properties
1 required
FormatSummary
object
Summary of a masking format.
3 properties
1 required
SdmMaskingPolicyDifference
object
A resource that tracks the differences between sensitive columns in the sensitive data model and masking columns in the masking policy
12 properties
9 required
SqlFirewallConfig
object
The SQL Firewall related configurations.
4 properties
2 required
ColumnSummary
object
The details of a column in a table fetched from the database.
8 properties
5 required
ScheduleReportDetails
object
The details of the report schedule.
6 properties
4 required
AlertsAggregationDimension
object
Details of aggregation dimension summarizing alerts.
1 property
1 required
AuditTrail
object
An audit trail represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. Configuring audi…
25 properties
9 required
CreateAttributeSetDetails
object
The details for an attribute set.
7 properties
4 required
TemplateAnalyticsCollection
object
The collection of template analytics summary.
1 property
1 required
AuditProfileCollection
object
Collection of audit profile summary.
1 property
1 required
SensitiveTypesExport
object
The resource represents sensitive types to be exported in Data Safe.
12 properties
6 required
CompareSecurityAssessmentDetails
object
Details specifying the security assessment used for comparison.
1 property
1 required
ChangeMaskingPolicyCompartmentDetails
object
Details to change the compartment of a masking policy.
1 property
1 required
SecurityPolicyDeploymentCollection
object
Collection of security policy deployment summary.
1 property
1 required
MaskingPolicyCollection
object
A collection of masking policy summary objects.
1 property
1 required
AuditProfileSummary
object
Summary of an audit profile.
18 properties
11 required
MaskingSchemaCollection
object
A collection of masking schema summary objects.
1 property
1 required
TargetDatabaseGroup
object
The details of the target database group including matching criteria. Used for a single resource retrieval.
14 properties
9 required
AuditProfileDimensions
object
Details of aggregation dimensions used for summarizing audit profiles.
5 properties
SecurityPolicyCollection
object
Collection of security policy summary.
1 property
1 required
ChangeTargetDatabaseGroupCompartmentDetails
object
The details used to change the compartment of the target database group.
1 property
1 required
UpdateAuditProfileDetails
object
The details used to update the audit profile.
6 properties
Dimensions
object
The scope of analytics data.
3 properties
TemplateBaselineDiffs
object
Results of the comparison of an item between two security assessments.
2 properties
CreateSdmMaskingPolicyDifferenceDetails
object
Details to create a new SDM masking policy difference.
6 properties
2 required
DownloadDiscoveryReportDetails
object
Details to download a discovery report.
2 properties
UpdatePeerTargetDatabaseDetails
object
The details of the peer database used for updating the peer target database in Data Safe.
4 properties
SensitiveColumnAnalyticsDimensions
object
The dimensions available for sensitive column analytics.
6 properties
DifferenceColumnSummary
object
Summary of a SDM masking policy difference column.
11 properties
7 required
UserAccessAnalyticsCollection
object
A collection of user access analytics summary objects.
1 property
1 required
DownloadUserAssessmentReportDetails
object
The details used to download a user assessment report.
1 property
1 required
TargetDatabaseGroupSummary
object
Summary of the target database group used in list operations. Contains essential information without matching criteria.
13 properties
8 required
SqlFirewallAllowedSqlDimensions
object
The dimensions available for SQL Firewall allow SQL analytics.
4 properties
ReportCollection
object
Collection of report summary.
1 property
1 required
SecurityAssessmentTemplateDetails
object
The details required to set the template for the assessment.
1 property
AuditPolicy
object
The resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in…
17 properties
7 required
WorkRequestError
object
An error related to a work request.
3 properties
3 required
RegistrationPolicySummary
object
A summary of a registration policy. This object contains key information about a registration policy, including its ID, compartment ID, display name, and lifec…
14 properties
12 required
DownloadSensitiveDataModelDetails
object
Details to download a sensitive data model.
1 property
SensitiveDataModelCollection
object
A collection of sensitive data model summary objects.
1 property
1 required
ReportSummary
object
Description of report.
14 properties
5 required
EnableDataSafeConfigurationDetails
object
The details used to enable Data Safe in the tenancy and region.
1 property
1 required
SqlFirewallViolationAggregationDimensions
object
The details of the aggregation dimensions used for summarizing SQL violations.
11 properties
PatchTargetAlertPolicyAssociationDetails
object
The details used to create associations for target databases and audit policies.
2 properties
2 required
CreateMaskingColumnDetails
object
Details to create a new masking column. You can use this to add a parent column only. It automatically adds the child columns from the associated sensitive dat…
8 properties
3 required
GroupedSensitiveTypeCollection
object
A collection of sensitive types summary objects present in a sensitive type group.
1 property
1 required
TemplateAnalyticsDimensions
object
The scope of analytics data.
12 properties
Report
object
The description of the report.
18 properties
5 required
AuditEventAnalyticsCollection
object
Audit events summarized detail.
1 property
1 required
UpdateSqlFirewallPolicyDetails
object
Details to update the SQL Firewall policy.
11 properties
UpdateAuditArchiveRetrievalDetails
object
Details to update the audit archive retrieval.
4 properties
DifferenceColumn
object
A SDM masking policy difference column. It can be one of the following three types: NEW: A new column in the sensitive data model that is not in the masking po…
11 properties
7 required
SecurityAssessmentComparison
object
Provides a list of the differences in a comparison of the security assessment with the baseline value.
5 properties
2 required
AlertCollection
object
Collection of alert summary.
1 property
1 required
MaskingReportSummary
object
Summary of a masking report.
22 properties
14 required
SecurityPolicyConfig
object
The Data Safe resource represents the common configurations corresponding to the associated security policy.
14 properties
6 required
DataSafePrivateEndpoint
object
A Data Safe private endpoint that allows Data Safe to connect to databases in a customer's virtual cloud network (VCN).
16 properties
6 required
Diffs
object
Results of the comparison of an item between two security assessments.
6 properties
LibraryMaskingFormatSummary
object
Summary of a library masking format.
11 properties
7 required
CreateColumnSourceDetails
object
Details to associate a column source with a masking policy.
1 property
1 required
SensitiveSchemaSummary
object
Summary of a sensitive schema present in a sensitive data model.
1 property
1 required
SqlFirewallPolicyAnalyticsCollection
object
SQL Firewall policy analytics collection.
1 property
1 required
DatabaseDetails
object
Details of the database for the registration in Data Safe.
2 properties
2 required
MaskingPolicyHealthReportSummary
object
Summary of a masking policy health report.
12 properties
9 required
ChangeMaskingPolicyHealthReportCompartmentDetails
object
Details to change the compartment of a masking policy.
1 property
1 required
CreateOnPremConnectorDetails
object
The details used to create a new on-premises connector.
5 properties
1 required
ColumnSourceDetails
object
The source of masking columns.
1 property
1 required
DiscoveryJobCollection
object
A collection of discovery job summary objects.
1 property
1 required
CalculateAuditVolumeAvailableDetails
object
The details for calculating audit data volume on target.
3 properties
SecurityAssessmentComparisonPerTarget
object
The results of the comparison between two security assessment resources.
9 properties
UpdateRegistrationPolicyDetails
object
The details required to update an existing registration policy. This object contains the necessary information to update a registration policy, including the d…
7 properties
UpdateReportDetails
object
The details for updating the report.
2 properties
AlertPolicyCollection
object
Collection of alert policy summary.
1 property
1 required
ChangeRetentionDetails
object
Details for the audit retention months to be modified.
3 properties
CheckSummary
object
The summary of the security rule to be evaluated by security assessment to create finding.
7 properties
2 required
UnifiedAuditPolicyConfig
object
The unified audit policy related configurations.
1 property
1 required
SecurityPolicyDeployment
object
The resource represents the state of the deployment of a security policy on a target.
15 properties
7 required
SensitiveType
object
A sensitive type defines a particular type or class of sensitive data. It can be a basic sensitive type with regular expressions or a sensitive category. While…
15 properties
8 required
SqlFirewallViolationAggregation
object
The details of SQL violations aggregation items.
6 properties
4 required
SqlFirewallAllowedSqlAggregation
object
The details of SQL Firewall allow SQL aggregate.
2 properties
2 required
SdmMaskingPolicyDifferenceColumnCollection
object
A collection of SDM masking policy difference column summary objects.
1 property
1 required
SelectionDetails
object
Details of the items to be selected and the mode of selection.
1 property
1 required
CreateReferentialRelationDetails
object
A sensitive column is a resource corresponding to a database column that is considered sensitive. It's a subresource of sensitive data model resource and is al…
4 properties
3 required
GroupMembersCollection
object
The criteria for displaying the members of a target database group.
1 property
1 required
TargetDatabase
object
The details of the Data Safe target database.
18 properties
6 required
UserAssessmentBaseLineDetails
object
The details required to set the baseline for the assessment.
1 property
CreateSensitiveTypeDetails
object
Details to create a new sensitive type.
8 properties
2 required
AuditTrailSummary
object
Summary of an audit trail.
17 properties
9 required
UpdateDataSafePrivateEndpointDetails
object
The details used to update the Data Safe private endpoint.
6 properties
ReportDefinition
object
Description of report definition.
29 properties
4 required
SecurityPolicySummary
object
The resource represents as a container for all the security policies in Data Safe.
12 properties
5 required
SqlCollectionLogDimensions
object
The dimensions available for SQL collection analytics.
3 properties
CreateDataSafePrivateEndpointDetails
object
The details used to create the new Data Safe private endpoint.
10 properties
4 required
DatabaseViewAccessEntryCollection
object
A collection of database view access summary objects.
1 property
1 required
ChangeUnifiedAuditPolicyCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
UpdateTargetDatabaseDetails
object
The details of the database used for updating the target database in Data Safe.
8 properties
AlertAggregationItems
object
Details of alerts aggregation items.
5 properties
4 required
Alert
object
The details of a Data Safe Alert, that shows alerts generated by a Data Safe feature.
22 properties
6 required
MaskingAnalyticsSummary
object
Summary of masking analytics data.
4 properties
2 required
CreateReportDefinitionDetails
object
Description of a new report definition.
10 properties
7 required
TargetDatabaseGroupCollection
object
The results of a target database group search. Contains target database group summary details.
1 property
1 required
AvailableAuditVolumeSummary
object
Represents the audit data volume collected by Data Safe from the target database for the specified audit profile.
6 properties
4 required
DiscoveryJobSummary
object
Summary of a discovery job.
11 properties
9 required
TlsConfig
object
The details required to establish a TLS enabled connection.
5 properties
1 required
AuditArchiveRetrievalCollection
object
Collection of archive retrieval summary.
1 property
1 required
UpdateUnifiedAuditPolicyDetails
object
The details required to create a new unified audit policy.
6 properties
SecurityAssessmentSummary
object
The summary of a security assessment.
27 properties
8 required
ChangeAuditArchiveRetrievalCompartmentDetails
object
The description of the achieve retrieval change compartment.
1 property
1 required
MaskingPolicyHealthReport
object
The masking policy health report.
13 properties
9 required
GenerateDiscoveryReportForDownloadDetails
object
Details to generate a downloadable discovery report.
2 properties
1 required
summary
object
Summary of the audit report.
6 properties
2 required
SensitiveColumnCollection
object
A collection of sensitive column summary objects.
1 property
1 required
SqlCollectionLogInsightsCollection
object
SQL collection log analytics collection.
1 property
1 required
SensitiveTypeGroup
object
The details of the sensitive type group.
11 properties
6 required
ChangeSensitiveDataModelCompartmentDetails
object
Details to change the compartment of a sensitive data model.
1 property
1 required
UpdateSecurityPolicyConfigDetails
object
The details to update the security policy configuration.
6 properties
ReportDetails
object
The details of the report schedule.
1 property
1 required
DownloadMaskingReportDetails
object
Details to download a masking report.
2 properties
2 required
SensitiveTypesExportCollection
object
A collection of sensitive types export summary objects.
1 property
1 required
SdmMaskingPolicyDifferenceCollection
object
A collection of SDM masking policy difference objects.
1 property
1 required
SecurityPolicyEntryState
object
The resource represents the state of a specific entry type deployment on a target.
8 properties
5 required
RoleGrantPathSummary
object
The summary of user role grant paths.
4 properties
1 required
AuditTrailDimensions
object
Details of aggregation dimensions used for summarizing audit trails.
4 properties
DatabaseTableAccessEntrySummary
object
Summary of DatabaseTableAccessEntry Object.
22 properties
1 required
AuditPolicySummary
object
The resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in…
15 properties
7 required
DatabaseTableAccessEntryCollection
object
A collection of database table access summary objects.
1 property
1 required
FindingSummary
object
The particular finding reported by the security assessment.
21 properties
WorkRequestSummary
object
Summary of a work request.
9 properties
7 required
CreateSecurityAssessmentDetails
object
The details used to save a security assessment.
11 properties
1 required
UpdateFindingDetails
object
Details to update a finding in a security assessment.
3 properties
DiscoveryJobResult
object
A discovery job result representing a sensitive column. It can be one of the following three types: NEW: A new sensitive column in the target database that is…
20 properties
12 required
UpdateSensitiveColumnDetails
object
Details to update a sensitive column in a sensitive data model.
7 properties
FindingAnalyticsCollection
object
The collection of the summary objects of the analytics data of findings or top findings.
1 property
1 required
DiscoveryJobResultSummary
object
Summary of a discovery job result.
16 properties
12 required
MaskingPolicyReferentialRelationCollection
object
A collection of referential relation summary objects.
1 property
1 required
CreateSecurityPolicyDeploymentDetails
object
Details to create the security policy deployment.
8 properties
4 required
ChangeDiscoveryJobCompartmentDetails
object
Details to change the compartment of a discovery job resource.
1 property
1 required
SensitiveDataModelSummary
object
Summary of a sensitive data model.
11 properties
8 required
CreateAuditProfileDetails
object
The details used to create a new audit profile.
11 properties
3 required
SecurityPolicyReport
object
The resource represents the security policy report
12 properties
6 required
AlertPolicyRuleSummary
object
A rule associated with an alert policy.
3 properties
2 required
AuditSpecification
object
Represents an audit policy relevant for the target database.The audit policy could be in any one of the following 3 states in the target database 1) Created an…
11 properties
10 required
CreateUserAssessmentDetails
object
The details required to save a user assessment.
8 properties
2 required
Exclude
object
Criteria to exclude certain target databases from the target database group.
1 property
1 required
SensitiveDataModel
object
A sensitive data model is a collection of sensitive columns and their referential relationships. It helps understand the sensitive data landscape, track change…
20 properties
12 required
CompatibleFormatsForDataTypes
object
A list of basic masking formats compatible with and grouped by the supported data types. The data types are grouped into the following categories - Character -…
1 property
1 required
SecurityPolicyReportSummary
object
The resource represents a container for all the security policy reports in Data Safe.
11 properties
6 required
CreateAuditArchiveRetrievalDetails
object
Request details for creating a new archive retrieval.
8 properties
4 required
SqlCollectionLogAggregation
object
The details of SQL collection log aggregation items.
5 properties
2 required
PatchAlertsDetails
object
The alert details to update the status of one or more alerts specified by the alert IDs.
2 properties
2 required
FindingAnalyticsDimensions
object
The scope of analytics data.
9 properties
PatchGroupedSensitiveTypesDetails
object
Details to patch sensitive types in a sensitive type group. INSERT and REMOVE operations are allowed.
1 property
RoleSummary
object
The details of a role fetched from the database.
7 properties
2 required
PolicyConnectionOption
object
Types of connection supported by Data Safe.
2 properties
2 required
CalculateAuditVolumeCollectedDetails
object
The details for calculating audit data volume collected by data safe.
2 properties
1 required
ChangeAlertCompartmentDetails
object
The details used to change the compartment of an alert.
1 property
1 required
DatabaseSecurityConfigCollection
object
Collection of database security config summaries.
1 property
1 required
CreateMaskingPolicyDetails
object
Details to create a new masking policy. Use either a sensitive data model or a reference target database to create your masking policy. To use a sensitive data…
13 properties
2 required
SecurityFeatureCollection
object
Collection of database security feature summary.
1 property
1 required
CreateTargetAlertPolicyAssociationDetails
object
The details used to create a new target-alert policy association.
9 properties
4 required
GenerateSensitiveDataModelForDownloadDetails
object
Details to generate a downloadable sensitive data model.
1 property
ChangeReportCompartmentDetails
object
The details of the compartment that the audit report is moving to.
1 property
1 required
UpdateUserAssessmentDetails
object
Updates one or more attributes of the specified user assessment.
5 properties
BulkCreateUnifiedAuditPolicyDetails
object
The details required to bulk create unified audit policies.
6 properties
3 required
UnifiedAuditPolicyDefinitionSummary
object
Resource represents a single unified audit policy definition.
15 properties
5 required
StartAuditTrailDetails
object
The details used to start an audit trail.
3 properties
1 required
MaskingPolicyHealthReportCollection
object
A collection of masking policy health report objects.
1 property
1 required
GlobalSettings
object
Details of the tenancy level global settings in Data Safe.
3 properties
UserSummary
object
The summary of information about the database user. It includes details such as user type, account status, last login time, user creation time, authentication…
15 properties
3 required
MaskingPolicySummary
object
Summary of a masking policy.
10 properties
6 required
UpdateTargetDatabaseGroupDetails
object
The information required to update the target database group.
5 properties
UpdateSqlCollectionDetails
object
Details to update the SQL collection.
4 properties
DictionarySummary
object
The details of date and time when the dictionary objects were last fetched from the database.
1 property
1 required
UnsetSecurityAssessmentBaselineDetails
object
The details required to unset the baseline of the assessment.
1 property
RunSecurityAssessmentDetails
object
The details required to create an on-demand saved security assessment.
4 properties
FormatEntry
object
A format entry is part of a masking format and defines the logic to mask data. A format entry can be a basic masking format such as Random Number, or it can be…
2 properties
1 required
UnifiedAuditPolicyCollection
object
Collection of audit policy summaries.
1 property
1 required
AuditPolicyAnalyticCollection
object
Details of audit policy aggregation.
1 property
1 required
UpdateAlertDetails
object
The details used to update an alert.
4 properties
TargetOverrideCollection
object
Collection of target override summary.
7 properties
7 required
ChangeSensitiveTypeGroupCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
CreateSensitiveColumnDetails
object
Details to create a new sensitive column in a sensitive data model.
12 properties
3 required
UpdateAuditPolicyDetails
object
Details to update the audit policy.
4 properties
ChangeAuditProfileCompartmentDetails
object
Moves the specified audit profile and its assoicated resources into a different compartment.
1 property
1 required
UserAccessAnalyticsSummary
object
Summary of user access analytics data
2 properties
2 required
AuditTrailAnalyticCollection
object
Details of audit trail analytic summary.
1 property
1 required
AuditTrailCollection
object
Collection of audit trail detail objects.
1 property
1 required
AuditConditions
object
Represents audit policies with corresponding audit provisioning conditions.
4 properties
3 required
CreatePeerTargetDatabaseDetails
object
The details used to register the peer database of a database already registered in Data Safe.
5 properties
1 required
SecurityFeatureAnalyticsDimensions
object
The scope of analytics data.
1 property
UpdateDatabaseSecurityConfigDetails
object
The details to update the database security config.
5 properties
ModifiedAttributes
object
The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows th…
2 properties
RoleGrantPathCollection
object
A collection of role grant path summary objects.
1 property
1 required
ChangeTargetAlertPolicyAssociationCompartmentDetails
object
The details used to change the compartment of a target-alert policy association.
1 property
1 required
MaskingErrorSummary
object
Summary of a masking error. A Masking error is an error seen during the masking run.
4 properties
3 required
MaskingColumnSummary
object
Summary of a masking column.
16 properties
9 required
PatchChecksDetails
object
Details to patch checks in a security assessment of type template.
1 property
DatabaseSecurityConfig
object
Database Security Configurations resource represents the target database configurations. Included in the Database Security Configurations are the SQL Firewall…
14 properties
6 required
BulkDeleteSqlFirewallAllowedSqlsDetails
object
Details of the allowed SQLs to be deleted from the SQL firewall policy.
2 properties
2 required
UnsetUserAssessmentBaselineDetails
object
The details required to unset the baseline of the assessment.
1 property
SecurityAssessment
object
A security assessment that provides an overall insight into your database security posture. The security assessment results are based on the analysis of your d…
30 properties
8 required
SecurityPolicyConfigCollection
object
Collection of security policy configuration summaries.
1 property
1 required
SqlFirewallAllowedSqlCollection
object
Collection of SQL Firewall allowed SQL statements.
1 property
1 required
UpdateSensitiveDataModelDetails
object
Details to update a sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.
12 properties
SensitiveColumnAnalyticsCollection
object
A collection of sensitive column analytics summary objects.
1 property
1 required
SecurityAssessmentTemplateBaselineComparison
object
Provides a list of the differences in a comparison of the security assessment with the template baseline value.
12 properties
4 required
ActivateTargetDatabaseDetails
object
The details required to reactivate a previously deactived target database in Data Safe.
1 property
UpdateSqlFirewallConfigDetails
object
Details to update the SQL Firewall config.
3 properties
SensitiveTypeGroupCollection
object
A collection of sensitive type group summary objects.
1 property
1 required
ChangeSensitiveTypesExportCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
UpdateOnPremConnectorWalletDetails
object
The details used to update an on-premises connector's wallet.
1 property
UpdateOnPremConnectorDetails
object
The details used to update a on-premises connector.
4 properties
DataSafeConfiguration
object
A Data Safe configuration for a tenancy and region.
9 properties
1 required
ChangeReportDefinitionCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
SensitiveTypeSummary
object
Summary of a sensitive type.
15 properties
8 required
PatchSensitiveColumnDetails
object
Details to patch columns in a sensitive data model.
1 property
TemplateAssociationAnalyticsDimensions
object
The scope of template association analytics data.
4 properties
MaskingFormat
object
A masking format defines the logic to mask data in a database column. The condition attribute defines the condition that must be true for applying the masking…
3 properties
1 required
CompatibleFormatsForSensitiveTypes
object
The list of compatible masking formats grouped by generic sensitive types.
1 property
1 required
SecurityFeatureAnalyticsSummary
object
The summary of database security feature analytics data.
3 properties
2 required
Error
object
Error Information.
2 properties
2 required
UpdateSecurityAssessmentDetails
object
Updates one or more attributes of the specified security assessment.
5 properties
UpdateSecurityPolicyDeploymentDetails
object
Details to update the security policy deployment.
4 properties
FormatsForSensitiveType
object
A list of library masking formats compatible with an existing sensitive type.
2 properties
1 required
MaskingColumn
object
A masking column is a resource corresponding to a database column that you want to mask. It's a subresource of masking policy resource and is always associated…
16 properties
9 required
UpdateTargetAlertPolicyAssociationDetails
object
The details used to update a target-alert policy association.
5 properties
AlertPolicy
object
An Alert Policy is a set of alerting rules evaluated against a target. The alert policy is said to be satisfied when all rules in the policy evaulate to true.…
13 properties
6 required
ChangeSensitiveTypeCompartmentDetails
object
Details to change the compartment of a sensitive type.
1 property
1 required
UpdateSensitiveTypeGroupDetails
object
Details to update a sensitive type group.
4 properties
FormatsForDataType
object
A list of basic masking formats compatible with a supported data type.
2 properties
1 required
ChangeSqlCollectionCompartmentDetails
object
Details for which compartment to move the resource to.
1 property
1 required
ChangeSecurityAssessmentCompartmentDetails
object
The details that can be changed (or retained) when a security assessment is moved to another compartment.
1 property
1 required
ModifyGlobalSettingsDetails
object
The details required to modify the global settings in Data Safe.
3 properties
CollectedAuditVolumeCollection
object
Collection of collected audit volume summary.
1 property
1 required
TablesForDiscovery
object
This contains the schema name along with one or more optional table names.
2 properties
1 required
SqlFirewallPolicyAggregation
object
The details of SQL Firewall policy.
2 properties
2 required
ProvisionAuditConditions
object
Represents audit policies with corresponding audit provisioning conditions.
4 properties
3 required
MaskingPolicyHealthReportLogSummary
object
A log entry related to the pre-masking health check.
6 properties
4 required
LibraryMaskingFormat
object
A library masking format is a masking format stored in an Oracle Cloud Infrastructure compartment and can be used in multiple masking policies. If you want to…
12 properties
7 required
TargetAlertPolicyUnassociatedSummary
object
Summary of the target databases that differ from the association of the target database group.
6 properties
2 required
ChangeUserAssessmentCompartmentDetails
object
The details used to change the compartment of the user assessment.
1 property
1 required
PatchSqlFirewallAllowedSqlDetails
object
The details used to delete multiple allowed sqls.
2 properties
2 required
PeerTargetDatabaseCollection
object
Summary of peer target databases of a primary target database.
3 properties
2 required
TargetAlertPolicyAssociationCollection
object
Collection of target to alert policy summary.
1 property
1 required
AttributeSetCollection
object
Collection of attribute sets.
1 property
1 required
AuditEventAggregationDimensions
object
The details of the aggregation dimensions used for summarizing audit events.
18 properties
TargetDatabaseSummary
object
Summary of a Data Safe target database.
14 properties
7 required
FindingsChangeAuditLogCollection
object
A collection of of all finding risk change audit log summary objects.
1 property
1 required
PatchSdmMaskingPolicyDifferenceColumnsDetails
object
Details to patch SDM masking policy difference.
1 property
AssociatedResourceSummary
object
Summary details of the associated resource of an attribute set.
5 properties
RegistrationPolicy
object
A registration policy. This object contains detailed information about a registration policy, including its ID, compartment ID, display name, and features.
16 properties
11 required
CreateSensitiveTypesExportDetails
object
Details to create a new sensitive types export. To specify some sensitive types for export, use sensitiveTypeIdsForExport attribute. But if you want to include…
7 properties
1 required
MaskingReport
object
A masking report contains information about a completed masking request. It includes details such as the target database masked, masking policy used, masking s…
22 properties
14 required
CreateRegistrationPolicyDetails
object
The details required to create a new registration policy. This object contains the necessary information to create a registration policy, including the compart…
9 properties
3 required
RunUserAssessmentDetails
object
The details required to create an on-demand saved user assessment.
5 properties
MaskingErrorCollection
object
A collection of masking error objects.
1 property
1 required
UpdateMaskingColumnDetails
object
Details to update a masking column.
5 properties
DiscoveryJobResultCollection
object
A collection of discovery job result summary objects.
1 property
1 required
ColumnsInfo
object
columnsInfo object has details of column group with schema details.
6 properties
5 required
UpdateSensitiveTypesExportDetails
object
Details to update a sensitive types export.
4 properties
TargetAlertPolicyAssociationSummary
object
A summary of target to alert policy association.
13 properties
5 required
SensitiveDataModelSensitiveTypeSummary
object
Summary of sensitive types present in a sensitive data model.
2 properties
2 required
SqlFirewallViolationsCollection
object
Collection of SQL violation summary.
1 property
1 required
SecurityPolicyDeploymentSummary
object
The resource represents the state of the deployment of a security policy on a target.
15 properties
7 required
ApplySdmMaskingPolicyDifferenceDetails
object
Details to apply the SDM masking policy difference to a masking policy.
1 property
1 required
Profile
object
The comprehensive information about the user profiles available on a given target. It includes details such as profile name, failed login attempts, password re…
27 properties
2 required
UpdateAttributeSetDetails
object
Details to update an attribute set.
5 properties
UpdateSecurityPolicyDetails
object
Details to update the security policy.
4 properties
UnifiedAuditPolicySummary
object
Resource represents a single unified audit policy on the target database.
16 properties
5 required
SqlFirewallAllowedSql
object
The resource represents a SQL Firewall allowed SQL in Data Safe.
17 properties
10 required
columnFilter
object
Filters that are applied to the data at the column level.
5 properties
5 required
ManagePrivilegesDetails
object
The details used to manage the features of a Data Safe target database.
1 property
1 required
SqlFirewallPolicySummary
object
The SQL Firewall policy resource contains the firewall policy metadata for a single user.
17 properties
8 required
column
object
The description of the column.
7 properties
4 required
SensitiveObjectCollection
object
A collection of sensitive object summary objects.
1 property
1 required
GenerateMaskingPolicyForDownloadDetails
object
Details to generate a downloadable masking policy.
1 property
SensitiveTypeCollection
object
A collection of sensitive type summary objects.
1 property
1 required
SdmMaskingPolicyDifferenceSummary
object
Summary of a SDM masking policy difference.
11 properties
9 required
CreateDiscoveryJobDetails
object
Details to create a new data discovery job.
14 properties
2 required
ChangeTargetDatabaseCompartmentDetails
object
The details used to change the compartment of a Data Safe target database.
1 property
1 required
ChangeDatabaseSecurityConfigCompartmentDetails
object
The details for which compartment to move the resource to.
1 property
1 required
Finding
object
The particular finding reported by the security assessment.
17 properties
AssociatedResourceCollection
object
The details of associated resources of an attribute set.
1 property
1 required
FirewallConfig
object
The SQL Firewall related configurations.
4 properties
2 required
GenerateReportDetails
object
Details for the report generation.
10 properties
3 required
SchemaSummary
object
The details of a schema fetched from the database.
2 properties
2 required
CreateSecurityPolicyConfigDetails
object
The details to create the security policy configuration.
8 properties
2 required
SecurityAssessmentStatistics
object
Statistics showing the number of findings for each category grouped by risk levels for all the targets in the specified security assessment. The categories inc…
8 properties
ApplyDiscoveryJobResultsDetails
object
Details to apply the discovery results to a sensitive data model.
1 property
1 required
MaskingReportCollection
object
A collection of masking report summary objects.
1 property
1 required
MaskingPolicy
object
A masking policy defines the approach to mask data in a target database. It's basically a collection of columns to be masked, called masking columns, and the a…
18 properties
11 required
MaskDataDetails
object
Details to mask data.
15 properties
FirewallConfigDetails
object
Details to update the SQL Firewall configuration.
3 properties
AuditArchiveRetrieval
object
Represents the archive retrieve request for the audit data. You can retrieve audit data for a target database from the archive and store it online. For more in…
17 properties
7 required
GenerateHealthReportDetails
object
Details to use when performing health check on a masking policy.
7 properties
CreateTargetDatabaseGroupDetails
object
The details used to create the target database group.
6 properties
3 required
DiscoveryAnalyticsSummary
object
Summary of discovery analytics data.
4 properties
2 required
TemplateAssociationAnalyticsCollection
object
The collection of template association analytics summary.
1 property
1 required
UpdateAuditTrailDetails
object
The details used to update an audit trail.
6 properties
SecurityPolicyEntryStateCollection
object
Collection of security policy entry state summary.
1 property
1 required
MaskingPolicyColumnsInfo
object
maskingPolicyColumnsInfo object has details of column group with schema details.
4 properties
4 required
ReferentialRelation
object
A referential relation is a resource corresponding to database columns. It's a subresource of sensitive data model resource and is always associated with a sen…
7 properties
6 required
SensitiveTypeGroupSummary
object
Summary of the sensitive type group.
11 properties
6 required
MaskingColumnCollection
object
A collection of masking column summary objects.
1 property
1 required
TargetAlertPolicyUnassociatedCollection
object
Collection of unassociated target alert policy association summary.
1 property
1 required
AlertsUpdateDetails
object
The details to update alerts in the specified compartment.
3 properties
2 required
DatabaseViewAccessEntrySummary
object
Summary of DatabaseViewAccess Object.
20 properties
2 required
ReferentialRelationCollection
object
A collection of referential relation summary objects.
1 property
1 required
MaskingObjectCollection
object
A collection of masking object summary objects.
1 property
1 required
ChangeSecurityPolicyCompartmentDetails
object
Details of the compartment the security policy will be moved to.
1 property
1 required
SqlFirewallAllowedSqlSummary
object
The resource represents a SQL Firewall allowed SQL in Data Safe.
17 properties
10 required
SensitiveColumn
object
A sensitive column is a resource corresponding to a database column that is considered sensitive. It's a subresource of sensitive data model resource and is al…
22 properties
15 required
AuditEventCollection
object
Collection of audit event summary.
1 property
1 required
SecurityPolicyReportCollection
object
Collection of security policy report summary.
1 property
1 required
TemplateBaselineDiffsPerTarget
object
The results of the comparison between two security assessment resources, and one of them is TEMPLATEBASELINE type.
4 properties
PatchInstruction
object
A single instruction to be included as part of Patch request content.
2 properties
2 required
UserAssessmentSummary
object
The summary of the user assessment.
24 properties
7 required
References
object
References to the sections of STIG, CIS, GDPR and/or ORP relevant to the current finding.
5 properties
AuditEventSummary
object
The resource represents the audit events collected from the target database by Oracle Data Safe.
41 properties
8 required
PatchFindingsDetails
object
Details to patch findings in a security assessment of type template baseline.
1 property
PeerTargetDatabaseSummary
object
The details of the peer target database in Data Safe.
9 properties
5 required
DownloadMaskingPolicyDetails
object
Details to download a masking policy.
1 property
EnableConditions
object
The details of the audit policy provisioning conditions.
4 properties
3 required
DatabaseSecurityConfigSummary
object
Database Security Configurations resource represents the target database configurations. Included in the Database Security Configurations are the SQL Firewall…
13 properties
6 required
CreateUnifiedAuditPolicyDetails
object
The details required to create a new unified audit policy.
9 properties
5 required
SqlFirewallAllowedSqlAnalyticsCollection
object
SQL Firewall allowed SQL analytics collection.
1 property
1 required
CreateSecurityPolicyDetails
object
Details to create the security policy.
5 properties
1 required
UpdateSensitiveTypeDetails
object
Details to update a sensitive type.
7 properties
1 required
UnifiedAuditPolicyConfigDetails
object
The unified audit policy related configurations.
1 property
TargetOverrideSummary
object
Summary of the target database-specific profiles that override the audit profile of the target database group.
10 properties
4 required
MaskingObjectSummary
object
Summary of a masking object present in a masking policy.
3 properties
3 required
UserAggregation
object
The user aggregation provides information about the overall security state of database users. For example, it states how many users have the DBA role and how m…
1 property
1 required
Include
object
Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseI…
6 properties
CompareUserAssessmentDetails
object
The details of the user assessment comparison.
1 property
1 required
AlertPolicySummary
object
Summary of a Data Safe alert policy.
12 properties
7 required
FindingAnalyticsSummary
object
The summary of information about the analytics data of findings or top findings. It includes details such as metric name, findingKey, title (topFindingCategory…
3 properties
2 required
SqlFirewallPolicyCollection
object
Collection of SQL Firewall policy summary.
1 property
1 required
ChangeLibraryMaskingFormatCompartmentDetails
object
Details to change the compartment of a library masking format.
1 property
1 required
ReportDefinitionCollection
object
Collection of report definition objects.
1 property
1 required
SensitiveObjectSummary
object
Summary of a sensitive object present in a sensitive data model.
3 properties
3 required
SensitiveColumnSummary
object
Summary of a sensitive column present in a sensitive data model.
19 properties
15 required
MaskedColumnSummary
object
Summary of a masked column. A masked column is a database column masked by a data masking request.
10 properties
7 required
SecurityPolicy
object
The resource represents as a container for all the security policies in Data Safe.
12 properties
5 required
AttributeSet
object
Represents an attribute set. An attribute set is a collection of data attributes defined by the user. i.e an attribute set of ip addresses, os user names or da…
14 properties
7 required
ReportDefinitionSummary
object
Summary of report definition.
15 properties
5 required
Compartments
object
Containing the OCID of the compartment and a boolean value to indicates compartmentIdInSubtree.
2 properties
1 required
SensitiveDataModelSensitiveTypeCollection
object
A collection of sensitive types summary objects present in a sensitive data model.
1 property
1 required
MatchingCriteria
object
Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target…
2 properties
1 required
PatchDiscoveryJobResultDetails
object
Details to patch discovery results.
1 property
GenerateUserAssessmentReportDetails
object
The details used to generate a new user assessment report.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from
This is an independent, third-party profile of Oracle Data Safe API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.