Data Safe Functions

Package: DBMS_CLOUD_OCI_DS_DATA_SAFE

ACTIVATE_TARGET_DATABASE Function

Reactivates a previously deactivated Data Safe target database.

Syntax

FUNCTION activate_target_database (
  activate_target_database_details dbms_cloud_oci_datasafe_activate_target_database_details_t,
  target_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_activate_target_database_response_t;

Parameters

Parameter	Description
`activate_target_database_details`	(required) The details used to reactivate a target database in Data Safe.
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_MASKING_COLUMNS_FROM_SDM Function

Adds columns to the specified masking policy from the associated sensitive data model. It automatically pulls all the sensitive columns and their relationships from the sensitive data model and uses this information to create columns in the masking policy. It also assigns default masking formats to these columns based on the associated sensitive types.

Syntax

FUNCTION add_masking_columns_from_sdm (
  masking_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_add_masking_columns_from_sdm_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ALERTS_UPDATE Function

Updates alerts in the specified compartment.

Syntax

FUNCTION alerts_update (
  alerts_update_details dbms_cloud_oci_datasafe_alerts_update_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_alerts_update_response_t;

Parameters

Parameter	Description
`alerts_update_details`	(required) The details to update the alerts in the specified compartment.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

APPLY_DISCOVERY_JOB_RESULTS Function

Applies the results of a discovery job to the specified sensitive data model. Note that the plannedAction attribute of discovery results is used for processing them. You should first use PatchDiscoveryJobResults to set the plannedAction attribute of the discovery results you want to process. ApplyDiscoveryJobResults automatically reads the plannedAction attribute and updates the sensitive data model to reflect the actions you planned.

Syntax

FUNCTION apply_discovery_job_results (
  sensitive_data_model_id varchar2,
  apply_discovery_job_results_details dbms_cloud_oci_datasafe_apply_discovery_job_results_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_apply_discovery_job_results_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`apply_discovery_job_results_details`	(required) Details to apply the discovery results to a sensitive data model.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

APPLY_SDM_MASKING_POLICY_DIFFERENCE Function

Applies the difference of a SDM Masking policy difference resource to the specified masking policy. Note that the plannedAction attribute of difference columns is used for processing. You should first use PatchSdmMaskingPolicyDifferenceColumns to set the plannedAction attribute of the difference columns you want to process. ApplySdmMaskingPolicyDifference automatically reads the plannedAction attribute and updates the masking policy to reflect the actions you planned. If the sdmMaskingPolicydifferenceId is not passed, the latest sdmMaskingPolicydifference is used. Note that if the masking policy associated with the SdmMaskingPolicyDifference used for this operation is not associated with the original SDM anymore, this operation won't be allowed.

Syntax

FUNCTION apply_sdm_masking_policy_difference (
  masking_policy_id varchar2,
  apply_sdm_masking_policy_difference_details dbms_cloud_oci_datasafe_apply_sdm_masking_policy_difference_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_apply_sdm_masking_policy_difference_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`apply_sdm_masking_policy_difference_details`	(required) Details to apply the SDM Masking policy difference columns to a masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CALCULATE_AUDIT_VOLUME_AVAILABLE Function

Calculates the volume of audit events available on the target database to be collected. Measurable up to the defined retention period of the audit target resource.

Syntax

FUNCTION calculate_audit_volume_available (
  audit_profile_id varchar2,
  calculate_audit_volume_available_details dbms_cloud_oci_datasafe_calculate_audit_volume_available_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_calculate_audit_volume_available_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`calculate_audit_volume_available_details`	(required) Details for the calculation of audit volume available on target database.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CALCULATE_AUDIT_VOLUME_COLLECTED Function

Calculates the volume of audit events collected by data safe.

Syntax

FUNCTION calculate_audit_volume_collected (
  audit_profile_id varchar2,
  calculate_audit_volume_collected_details dbms_cloud_oci_datasafe_calculate_audit_volume_collected_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_calculate_audit_volume_collected_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`calculate_audit_volume_collected_details`	(required) Details for the calculation of audit volume collected by data safe.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_WORK_REQUEST Function

Cancel the specified work request.

Syntax

FUNCTION cancel_work_request (
  work_request_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_cancel_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ALERT_COMPARTMENT Function

Moves the specified alert into a different compartment.

Syntax

FUNCTION change_alert_compartment (
  alert_id varchar2,
  change_alert_compartment_details dbms_cloud_oci_datasafe_change_alert_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_alert_compartment_response_t;

Parameters

Parameter	Description
`alert_id`	(required) The OCID of alert.
`change_alert_compartment_details`	(required) The details used to change the compartment of an alert.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AUDIT_ARCHIVE_RETRIEVAL_COMPARTMENT Function

Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource.

Syntax

FUNCTION change_audit_archive_retrieval_compartment (
  audit_archive_retrieval_id varchar2,
  change_audit_archive_retrieval_compartment_details dbms_cloud_oci_datasafe_change_audit_archive_retrieval_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_audit_archive_retrieval_compartment_response_t;

Parameters

Parameter	Description
`audit_archive_retrieval_id`	(required) OCID of the archive retrieval.
`change_audit_archive_retrieval_compartment_details`	(required) The details used to change the compartment of a archive retrieval.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AUDIT_POLICY_COMPARTMENT Function

Moves the specified audit policy and its dependent resources into a different compartment.

Syntax

FUNCTION change_audit_policy_compartment (
  audit_policy_id varchar2,
  change_audit_policy_compartment_details dbms_cloud_oci_datasafe_change_audit_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_audit_policy_compartment_response_t;

Parameters

Parameter	Description
`audit_policy_id`	(required) Unique audit policy identifier.
`change_audit_policy_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AUDIT_PROFILE_COMPARTMENT Function

Moves the specified audit profile and its dependent resources into a different compartment.

Syntax

FUNCTION change_audit_profile_compartment (
  audit_profile_id varchar2,
  change_audit_profile_compartment_details dbms_cloud_oci_datasafe_change_audit_profile_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_audit_profile_compartment_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`change_audit_profile_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATA_SAFE_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

Syntax

FUNCTION change_data_safe_private_endpoint_compartment (
  data_safe_private_endpoint_id varchar2,
  change_data_safe_private_endpoint_compartment_details dbms_cloud_oci_datasafe_change_data_safe_private_endpoint_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_data_safe_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`data_safe_private_endpoint_id`	(required) The OCID of the private endpoint.
`change_data_safe_private_endpoint_compartment_details`	(required) The details used to change the compartment of a Data Safe private endpoint.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_SECURITY_CONFIG_COMPARTMENT Function

Moves the specified database security configuration and its dependent resources into a different compartment.

Syntax

FUNCTION change_database_security_config_compartment (
  database_security_config_id varchar2,
  change_database_security_config_compartment_details dbms_cloud_oci_datasafe_change_database_security_config_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_database_security_config_compartment_response_t;

Parameters

Parameter	Description
`database_security_config_id`	(required) The OCID of the database security configuration resource.
`change_database_security_config_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DISCOVERY_JOB_COMPARTMENT Function

Moves the specified discovery job and its dependent resources into a different compartment.

Syntax

FUNCTION change_discovery_job_compartment (
  discovery_job_id varchar2,
  change_discovery_job_compartment_details dbms_cloud_oci_datasafe_change_discovery_job_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_discovery_job_compartment_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`change_discovery_job_compartment_details`	(required) The details used to change the compartment of a resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_LIBRARY_MASKING_FORMAT_COMPARTMENT Function

Moves the specified library masking format into a different compartment.

Syntax

FUNCTION change_library_masking_format_compartment (
  library_masking_format_id varchar2,
  change_library_masking_format_compartment_details dbms_cloud_oci_datasafe_change_library_masking_format_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_library_masking_format_compartment_response_t;

Parameters

Parameter	Description
`library_masking_format_id`	(required) The OCID of the library masking format.
`change_library_masking_format_compartment_details`	(required) Details to change the compartment of a library masking format.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MASKING_POLICY_COMPARTMENT Function

Moves the specified masking policy and its dependent resources into a different compartment.

Syntax

FUNCTION change_masking_policy_compartment (
  masking_policy_id varchar2,
  change_masking_policy_compartment_details dbms_cloud_oci_datasafe_change_masking_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_masking_policy_compartment_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`change_masking_policy_compartment_details`	(required) Details to change the compartment of a masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ON_PREM_CONNECTOR_COMPARTMENT Function

Moves the specified on-premises connector into a different compartment.

Syntax

FUNCTION change_on_prem_connector_compartment (
  on_prem_connector_id varchar2,
  change_on_prem_connector_compartment_details dbms_cloud_oci_datasafe_change_on_prem_connector_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_on_prem_connector_compartment_response_t;

Parameters

Parameter	Description
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`change_on_prem_connector_compartment_details`	(required) The details used to change the compartment of an on-premises connector.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REPORT_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_report_compartment (
  report_id varchar2,
  change_report_compartment_details dbms_cloud_oci_datasafe_change_report_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_report_compartment_response_t;

Parameters

Parameter	Description
`report_id`	(required) Unique report identifier
`change_report_compartment_details`	(required) Details for the different Report.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REPORT_DEFINITION_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_report_definition_compartment (
  report_definition_id varchar2,
  change_report_definition_compartment_details dbms_cloud_oci_datasafe_change_report_definition_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_report_definition_compartment_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`change_report_definition_compartment_details`	(required) Details for the different ReportDefinition.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_RETENTION Function

Change the online and offline months .

Syntax

FUNCTION change_retention (
  audit_profile_id varchar2,
  change_retention_details dbms_cloud_oci_datasafe_change_retention_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_retention_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`change_retention_details`	(required) Details for the audit retention months to be modified.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SDM_MASKING_POLICY_DIFFERENCE_COMPARTMENT Function

Moves the specified SDM masking policy difference into a different compartment.

Syntax

FUNCTION change_sdm_masking_policy_difference_compartment (
  sdm_masking_policy_difference_id varchar2,
  change_sdm_masking_policy_difference_compartment_details dbms_cloud_oci_datasafe_change_sdm_masking_policy_difference_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_sdm_masking_policy_difference_compartment_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`change_sdm_masking_policy_difference_compartment_details`	(required) The details used to change the compartment of a resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SECURITY_ASSESSMENT_COMPARTMENT Function

Moves the specified saved security assessment or future scheduled assessments into a different compartment. To start, call first the operation ListSecurityAssessments with filters \"type = save_schedule\". This returns the scheduleAssessmentId. Then, call this changeCompartment with the scheduleAssessmentId. The existing saved security assessments created due to the schedule are not moved. However, all new saves will be associated with the new compartment.

Syntax

FUNCTION change_security_assessment_compartment (
  security_assessment_id varchar2,
  change_security_assessment_compartment_details dbms_cloud_oci_datasafe_change_security_assessment_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_security_assessment_compartment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`change_security_assessment_compartment_details`	(required) The details used to change the compartment of a security assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SECURITY_POLICY_COMPARTMENT Function

Moves the specified security policy and its dependent resources into a different compartment.

Syntax

FUNCTION change_security_policy_compartment (
  security_policy_id varchar2,
  change_security_policy_compartment_details dbms_cloud_oci_datasafe_change_security_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_security_policy_compartment_response_t;

Parameters

Parameter	Description
`security_policy_id`	(required) The OCID of the security policy resource.
`change_security_policy_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT Function

Moves the specified security policy deployment and its dependent resources into a different compartment.

Syntax

FUNCTION change_security_policy_deployment_compartment (
  security_policy_deployment_id varchar2,
  change_security_policy_deployment_compartment_details dbms_cloud_oci_datasafe_change_security_policy_deployment_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_security_policy_deployment_compartment_response_t;

Parameters

Parameter	Description
`security_policy_deployment_id`	(required) The OCID of the security policy deployment resource.
`change_security_policy_deployment_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SENSITIVE_DATA_MODEL_COMPARTMENT Function

Moves the specified sensitive data model and its dependent resources into a different compartment.

Syntax

FUNCTION change_sensitive_data_model_compartment (
  sensitive_data_model_id varchar2,
  change_sensitive_data_model_compartment_details dbms_cloud_oci_datasafe_change_sensitive_data_model_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_sensitive_data_model_compartment_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`change_sensitive_data_model_compartment_details`	(required) Details to change the compartment of a sensitive data model.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SENSITIVE_TYPE_COMPARTMENT Function

Moves the specified sensitive type into a different compartment.

Syntax

FUNCTION change_sensitive_type_compartment (
  sensitive_type_id varchar2,
  change_sensitive_type_compartment_details dbms_cloud_oci_datasafe_change_sensitive_type_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_sensitive_type_compartment_response_t;

Parameters

Parameter	Description
`sensitive_type_id`	(required) The OCID of the sensitive type.
`change_sensitive_type_compartment_details`	(required) Details to change the compartment of a sensitive type.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SQL_COLLECTION_COMPARTMENT Function

Moves the specified SQL collection and its dependent resources into a different compartment.

Syntax

FUNCTION change_sql_collection_compartment (
  sql_collection_id varchar2,
  change_sql_collection_compartment_details dbms_cloud_oci_datasafe_change_sql_collection_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_sql_collection_compartment_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`change_sql_collection_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SQL_FIREWALL_POLICY_COMPARTMENT Function

Moves the specified SQL Firewall policy and its dependent resources into a different compartment.

Syntax

FUNCTION change_sql_firewall_policy_compartment (
  sql_firewall_policy_id varchar2,
  change_sql_firewall_policy_compartment_details dbms_cloud_oci_datasafe_change_sql_firewall_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_sql_firewall_policy_compartment_response_t;

Parameters

Parameter	Description
`sql_firewall_policy_id`	(required) The OCID of the SQL Firewall policy resource.
`change_sql_firewall_policy_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_TARGET_ALERT_POLICY_ASSOCIATION_COMPARTMENT Function

Moves the specified target-alert policy Association into a different compartment.

Syntax

FUNCTION change_target_alert_policy_association_compartment (
  target_alert_policy_association_id varchar2,
  change_target_alert_policy_association_compartment_details dbms_cloud_oci_datasafe_change_target_alert_policy_association_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_target_alert_policy_association_compartment_response_t;

Parameters

Parameter	Description
`target_alert_policy_association_id`	(required) The OCID of the target-alert policy association.
`change_target_alert_policy_association_compartment_details`	(required) The details used to change the compartment of a target-alert policy association.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_TARGET_DATABASE_COMPARTMENT Function

Moves the Data Safe target database to the specified compartment.

Syntax

FUNCTION change_target_database_compartment (
  target_database_id varchar2,
  change_target_database_compartment_details dbms_cloud_oci_datasafe_change_target_database_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_target_database_compartment_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`change_target_database_compartment_details`	(required) Details of the move compartment request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_USER_ASSESSMENT_COMPARTMENT Function

Moves the specified saved user assessment or future scheduled assessments into a different compartment. To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with the filters \"type = save_schedule\". That call returns the scheduleAssessmentId. Then call ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule are not be moved. However, all new saves will be associated with the new compartment.

Syntax

FUNCTION change_user_assessment_compartment (
  user_assessment_id varchar2,
  change_user_assessment_compartment_details dbms_cloud_oci_datasafe_change_user_assessment_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_change_user_assessment_compartment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`change_user_assessment_compartment_details`	(required) The details used to change the compartment of a user assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COMPARE_SECURITY_ASSESSMENT Function

Compares two security assessments. For this comparison, a security assessment can be a saved assessment, a latest assessment, or a baseline assessment. For example, you can compare saved assessment or a latest assessment against a baseline.

Syntax

FUNCTION compare_security_assessment (
  security_assessment_id varchar2,
  compare_security_assessment_details dbms_cloud_oci_datasafe_compare_security_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_compare_security_assessment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`compare_security_assessment_details`	(required) Details of the security assessment comparison.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COMPARE_USER_ASSESSMENT Function

Compares two user assessments. For this comparison, a user assessment can be a saved, a latest assessment, or a baseline. As an example, it can be used to compare a user assessment saved or a latest assessment with a baseline.

Syntax

FUNCTION compare_user_assessment (
  user_assessment_id varchar2,
  compare_user_assessment_details dbms_cloud_oci_datasafe_compare_user_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_compare_user_assessment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`compare_user_assessment_details`	(required) Details of the user assessment comparison.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_AUDIT_ARCHIVE_RETRIEVAL Function

Creates a work request to retrieve archived audit data. This asynchronous process will usually take over an hour to complete. Save the id from the response of this operation. Call GetAuditArchiveRetrieval operation after an hour, passing the id to know the status of this operation.

Syntax

FUNCTION create_audit_archive_retrieval (
  create_audit_archive_retrieval_details dbms_cloud_oci_datasafe_create_audit_archive_retrieval_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_audit_archive_retrieval_response_t;

Parameters

Parameter	Description
`create_audit_archive_retrieval_details`	(required) Details for creating retrieving archived audit data.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATA_SAFE_PRIVATE_ENDPOINT Function

Creates a new Data Safe private endpoint.

Syntax

FUNCTION create_data_safe_private_endpoint (
  create_data_safe_private_endpoint_details dbms_cloud_oci_datasafe_create_data_safe_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_data_safe_private_endpoint_response_t;

Parameters

Parameter	Description
`create_data_safe_private_endpoint_details`	(required) Details to create a new private endpoint.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DISCOVERY_JOB Function

Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. After performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults to specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results and apply them to the sensitive data model.

Syntax

FUNCTION create_discovery_job (
  create_discovery_job_details dbms_cloud_oci_datasafe_create_discovery_job_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_discovery_job_response_t;

Parameters

Parameter	Description
`create_discovery_job_details`	(required) The details used to run an incremental data discovery job
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_LIBRARY_MASKING_FORMAT Function

Creates a new library masking format. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.

Syntax

FUNCTION create_library_masking_format (
  create_library_masking_format_details dbms_cloud_oci_datasafe_create_library_masking_format_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_library_masking_format_response_t;

Parameters

Parameter	Description
`create_library_masking_format_details`	(required) Details to create a new library masking format.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MASKING_COLUMN Function

Creates a new masking column in the specified masking policy. Use this operation to add parent columns only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column. Using the maskingFormats attribute, you can assign one or more masking formats to a column. You need to specify a condition as part of each masking format. It enables you to do <a href=\"https://docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html\">conditional masking</a> so that you can mask the column data values differently using different masking conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do <a href=\"https://docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037\">group or compound masking</a> that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Syntax

FUNCTION create_masking_column (
  create_masking_column_details dbms_cloud_oci_datasafe_create_masking_column_details_t,
  masking_policy_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_masking_column_response_t;

Parameters

Parameter	Description
`create_masking_column_details`	(required) Details to create a new masking column.
`masking_policy_id`	(required) The OCID of the masking policy.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MASKING_POLICY Function

Creates a new masking policy and associates it with a sensitive data model or a target database. To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations. You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations. After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.

Syntax

FUNCTION create_masking_policy (
  create_masking_policy_details dbms_cloud_oci_datasafe_create_masking_policy_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_masking_policy_response_t;

Parameters

Parameter	Description
`create_masking_policy_details`	(required) Details to create a new masking policy.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ON_PREM_CONNECTOR Function

Creates a new on-premises connector.

Syntax

FUNCTION create_on_prem_connector (
  create_on_prem_connector_details dbms_cloud_oci_datasafe_create_on_prem_connector_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_on_prem_connector_response_t;

Parameters

Parameter	Description
`create_on_prem_connector_details`	(required) The details used to create a new on-premises connector.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REPORT_DEFINITION Function

Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.

Syntax

FUNCTION create_report_definition (
  create_report_definition_details dbms_cloud_oci_datasafe_create_report_definition_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_report_definition_response_t;

Parameters

Parameter	Description
`create_report_definition_details`	(required) Details for the new report definition.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SDM_MASKING_POLICY_DIFFERENCE Function

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. After performing this operation, you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the difference columns and apply them to the masking policy.

Syntax

FUNCTION create_sdm_masking_policy_difference (
  create_sdm_masking_policy_difference_details dbms_cloud_oci_datasafe_create_sdm_masking_policy_difference_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_sdm_masking_policy_difference_response_t;

Parameters

Parameter	Description
`create_sdm_masking_policy_difference_details`	(required) The details used to create a SDM masking policy difference resource
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SECURITY_ASSESSMENT Function

Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, at the defined date and time, in the format defined by RFC3339.

Syntax

FUNCTION create_security_assessment (
  create_security_assessment_details dbms_cloud_oci_datasafe_create_security_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_security_assessment_response_t;

Parameters

Parameter	Description
`create_security_assessment_details`	(required) The details used to create a new saved security assessment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SENSITIVE_COLUMN Function

Creates a new sensitive column in the specified sensitive data model.

Syntax

FUNCTION create_sensitive_column (
  sensitive_data_model_id varchar2,
  create_sensitive_column_details dbms_cloud_oci_datasafe_create_sensitive_column_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_sensitive_column_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`create_sensitive_column_details`	(required) Details to create a new sensitive column.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SENSITIVE_DATA_MODEL Function

Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later.

Syntax

FUNCTION create_sensitive_data_model (
  create_sensitive_data_model_details dbms_cloud_oci_datasafe_create_sensitive_data_model_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_sensitive_data_model_response_t;

Parameters

Parameter	Description
`create_sensitive_data_model_details`	(required) Details to create a new sensitive data model.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SENSITIVE_TYPE Function

Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types.

Syntax

FUNCTION create_sensitive_type (
  create_sensitive_type_details dbms_cloud_oci_datasafe_create_sensitive_type_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_sensitive_type_response_t;

Parameters

Parameter	Description
`create_sensitive_type_details`	(required) Details to create a new sensitive type.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SQL_COLLECTION Function

Creates a new SQL collection resource.

Syntax

FUNCTION create_sql_collection (
  create_sql_collection_details dbms_cloud_oci_datasafe_create_sql_collection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_sql_collection_response_t;

Parameters

Parameter	Description
`create_sql_collection_details`	(required) Details of the SQL collection.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TARGET_ALERT_POLICY_ASSOCIATION Function

Creates a new target-alert policy association to track a alert policy applied on target.

Syntax

FUNCTION create_target_alert_policy_association (
  create_target_alert_policy_association_details dbms_cloud_oci_datasafe_create_target_alert_policy_association_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_target_alert_policy_association_response_t;

Parameters

Parameter	Description
`create_target_alert_policy_association_details`	(required) The details used to create a new target-alert policy association.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TARGET_DATABASE Function

Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.

Syntax

FUNCTION create_target_database (
  create_target_database_details dbms_cloud_oci_datasafe_create_target_database_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_target_database_response_t;

Parameters

Parameter	Description
`create_target_database_details`	(required) Details of the target database.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_USER_ASSESSMENT Function

Creates a new saved user assessment for one or multiple targets in a compartment. It saves the latest assessments in the specified compartment. If a scheduled is passed in, this operation persists the latest assessments that exist at the defined date and time, in the format defined by RFC3339.

Syntax

FUNCTION create_user_assessment (
  create_user_assessment_details dbms_cloud_oci_datasafe_create_user_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_create_user_assessment_response_t;

Parameters

Parameter	Description
`create_user_assessment_details`	(required) The details used to create a new saved user assessment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEACTIVATE_TARGET_DATABASE Function

Deactivates a target database in Data Safe.

Syntax

FUNCTION deactivate_target_database (
  target_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_deactivate_target_database_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AUDIT_ARCHIVE_RETRIEVAL Function

To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.

Syntax

FUNCTION delete_audit_archive_retrieval (
  audit_archive_retrieval_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_audit_archive_retrieval_response_t;

Parameters

Parameter	Description
`audit_archive_retrieval_id`	(required) OCID of the archive retrieval.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AUDIT_TRAIL Function

Deletes the specified audit trail.

Syntax

FUNCTION delete_audit_trail (
  audit_trail_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_audit_trail_response_t;

Parameters

Parameter	Description
`audit_trail_id`	(required) The OCID of the audit trail.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATA_SAFE_PRIVATE_ENDPOINT Function

Deletes the specified Data Safe private endpoint.

Syntax

FUNCTION delete_data_safe_private_endpoint (
  data_safe_private_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_data_safe_private_endpoint_response_t;

Parameters

Parameter	Description
`data_safe_private_endpoint_id`	(required) The OCID of the private endpoint.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DISCOVERY_JOB Function

Deletes the specified discovery job.

Syntax

FUNCTION delete_discovery_job (
  discovery_job_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_discovery_job_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DISCOVERY_JOB_RESULT Function

Deletes the specified discovery result.

Syntax

FUNCTION delete_discovery_job_result (
  discovery_job_id varchar2,
  result_key varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_discovery_job_result_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`result_key`	(required) The unique key that identifies the discovery result.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_LIBRARY_MASKING_FORMAT Function

Deletes the specified library masking format.

Syntax

FUNCTION delete_library_masking_format (
  library_masking_format_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_library_masking_format_response_t;

Parameters

Parameter	Description
`library_masking_format_id`	(required) The OCID of the library masking format.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MASKING_COLUMN Function

Deletes the specified masking column.

Syntax

FUNCTION delete_masking_column (
  masking_column_key varchar2,
  masking_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_masking_column_response_t;

Parameters

Parameter	Description
`masking_column_key`	(required) The unique key that identifies the masking column. It's numeric and unique within a masking policy.
`masking_policy_id`	(required) The OCID of the masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MASKING_POLICY Function

Deletes the specified masking policy.

Syntax

FUNCTION delete_masking_policy (
  masking_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_masking_policy_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ON_PREM_CONNECTOR Function

Deletes the specified on-premises connector.

Syntax

FUNCTION delete_on_prem_connector (
  on_prem_connector_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_on_prem_connector_response_t;

Parameters

Parameter	Description
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REPORT_DEFINITION Function

Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.

Syntax

FUNCTION delete_report_definition (
  report_definition_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_report_definition_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SDM_MASKING_POLICY_DIFFERENCE Function

Deletes the specified SDM Masking policy difference.

Syntax

FUNCTION delete_sdm_masking_policy_difference (
  sdm_masking_policy_difference_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sdm_masking_policy_difference_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SECURITY_ASSESSMENT Function

Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, first call the operation ListSecurityAssessments with filters \"type = save_schedule\". That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Syntax

FUNCTION delete_security_assessment (
  security_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_security_assessment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SENSITIVE_COLUMN Function

Deletes the specified sensitive column.

Syntax

FUNCTION delete_sensitive_column (
  sensitive_data_model_id varchar2,
  sensitive_column_key varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sensitive_column_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`sensitive_column_key`	(required) The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SENSITIVE_DATA_MODEL Function

Deletes the specified sensitive data model.

Syntax

FUNCTION delete_sensitive_data_model (
  sensitive_data_model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sensitive_data_model_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SENSITIVE_TYPE Function

Deletes the specified sensitive type.

Syntax

FUNCTION delete_sensitive_type (
  sensitive_type_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sensitive_type_response_t;

Parameters

Parameter	Description
`sensitive_type_id`	(required) The OCID of the sensitive type.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SQL_COLLECTION Function

Deletes the specified SQL collection.

Syntax

FUNCTION delete_sql_collection (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sql_collection_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SQL_FIREWALL_POLICY Function

Deletes the SQL Firewall policy resource.

Syntax

FUNCTION delete_sql_firewall_policy (
  sql_firewall_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_sql_firewall_policy_response_t;

Parameters

Parameter	Description
`sql_firewall_policy_id`	(required) The OCID of the SQL Firewall policy resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TARGET_ALERT_POLICY_ASSOCIATION Function

Deletes the specified target-alert policy Association.

Syntax

FUNCTION delete_target_alert_policy_association (
  target_alert_policy_association_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_target_alert_policy_association_response_t;

Parameters

Parameter	Description
`target_alert_policy_association_id`	(required) The OCID of the target-alert policy association.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TARGET_DATABASE Function

Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

Syntax

FUNCTION delete_target_database (
  target_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_target_database_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_USER_ASSESSMENT Function

Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation ListUserAssessments with filters \"type = save_schedule\". That call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Syntax

FUNCTION delete_user_assessment (
  user_assessment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_delete_user_assessment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISCOVER_AUDIT_TRAILS Function

Updates the list of audit trails created under audit profile.The operation can be used to create new audit trails for target database when they become available for audit collection because of change of database version or change of database unified mode or change of data base edition or being deleted previously etc.

Syntax

FUNCTION discover_audit_trails (
  audit_profile_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_discover_audit_trails_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_DISCOVERY_REPORT Function

Downloads an already-generated discovery report. Note that the GenerateDiscoveryReportForDownload operation is a prerequisite for the DownloadDiscoveryReport operation. Use GenerateDiscoveryReportForDownload to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it downloads report for all the columns in a sensitive data model. Use the discoveryJobId attribute to download report for a specific discovery job.

Syntax

FUNCTION download_discovery_report (
  sensitive_data_model_id varchar2,
  download_discovery_report_details dbms_cloud_oci_datasafe_download_discovery_report_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_discovery_report_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`download_discovery_report_details`	(required) Details to download a discovery report.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_MASKING_LOG Function

Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.

Syntax

FUNCTION download_masking_log (
  masking_policy_id varchar2,
  download_masking_log_details dbms_cloud_oci_datasafe_download_masking_log_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_masking_log_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`download_masking_log_details`	(required) Details to download masking log.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_MASKING_POLICY Function

Downloads an already-generated file corresponding to the specified masking policy. Note that the GenerateMaskingPolicyForDownload operation is a prerequisite for the DownloadMaskingPolicy operation. Use GenerateMaskingPolicyForDownload to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file.

Syntax

FUNCTION download_masking_policy (
  masking_policy_id varchar2,
  download_masking_policy_details dbms_cloud_oci_datasafe_download_masking_policy_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_masking_policy_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`download_masking_policy_details`	(required) Details to download a masking policy file.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_MASKING_REPORT Function

Downloads an already-generated masking report. Note that the GenerateMaskingReportForDownload operation is a prerequisite for the DownloadMaskingReport operation. Use GenerateMaskingReportForDownload to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Syntax

FUNCTION download_masking_report (
  masking_policy_id varchar2,
  download_masking_report_details dbms_cloud_oci_datasafe_download_masking_report_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_masking_report_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`download_masking_report_details`	(required) Details to download a masking report.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_PRIVILEGE_SCRIPT Function

Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

Syntax

FUNCTION download_privilege_script (
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_privilege_script_response_t;

Parameters

Parameter	Description
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_SECURITY_ASSESSMENT_REPORT Function

Downloads the report of the specified security assessment. To download the security assessment report, it needs to be generated first. Please use GenerateSecurityAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Syntax

FUNCTION download_security_assessment_report (
  security_assessment_id varchar2,
  download_security_assessment_report_details dbms_cloud_oci_datasafe_download_security_assessment_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_security_assessment_report_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`download_security_assessment_report_details`	(required) Details of the report.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_SENSITIVE_DATA_MODEL Function

Downloads an already-generated file corresponding to the specified sensitive data model. Note that the GenerateSensitiveDataModelForDownload operation is a prerequisite for the DownloadSensitiveDataModel operation. Use GenerateSensitiveDataModelForDownload to generate a data model file and then use DownloadSensitiveDataModel to download the generated file.

Syntax

FUNCTION download_sensitive_data_model (
  sensitive_data_model_id varchar2,
  download_sensitive_data_model_details dbms_cloud_oci_datasafe_download_sensitive_data_model_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_sensitive_data_model_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`download_sensitive_data_model_details`	(required) Details to download a sensitive data model file.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_USER_ASSESSMENT_REPORT Function

Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. Please use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Syntax

FUNCTION download_user_assessment_report (
  user_assessment_id varchar2,
  download_user_assessment_report_details dbms_cloud_oci_datasafe_download_user_assessment_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_download_user_assessment_report_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`download_user_assessment_report_details`	(required) Details of the report.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_DATA_SAFE_CONFIGURATION Function

Enables Data Safe in the tenancy and region.

Syntax

FUNCTION enable_data_safe_configuration (
  enable_data_safe_configuration_details dbms_cloud_oci_datasafe_enable_data_safe_configuration_details_t,
  compartment_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_enable_data_safe_configuration_response_t;

Parameters

Parameter	Description
`enable_data_safe_configuration_details`	(required) The details used to enable Data Safe.
`compartment_id`	(optional) A filter to return only resources that match the specified compartment OCID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_DISCOVERY_REPORT_FOR_DOWNLOAD Function

Generates a downloadable discovery report. It's a prerequisite for the DownloadDiscoveryReport operation. Use this endpoint to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it generates report for all the columns in a sensitive data model. Use the discoveryJobId attribute to generate report for a specific discovery job.

Syntax

FUNCTION generate_discovery_report_for_download (
  sensitive_data_model_id varchar2,
  generate_discovery_report_for_download_details dbms_cloud_oci_datasafe_generate_discovery_report_for_download_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_discovery_report_for_download_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`generate_discovery_report_for_download_details`	(required) Details to generate a downloadable discovery report.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_MASKING_POLICY_FOR_DOWNLOAD Function

Generates a downloadable file corresponding to the specified masking policy. It's a prerequisite for the DownloadMaskingPolicy operation. Use this endpoint to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Syntax

FUNCTION generate_masking_policy_for_download (
  masking_policy_id varchar2,
  generate_masking_policy_for_download_details dbms_cloud_oci_datasafe_generate_masking_policy_for_download_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_masking_policy_for_download_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`generate_masking_policy_for_download_details`	(required) Details to generate a masking policy file.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_MASKING_REPORT_FOR_DOWNLOAD Function

Generates a downloadable masking report. It's a prerequisite for the DownloadMaskingReport operation. Use this endpoint to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Syntax

FUNCTION generate_masking_report_for_download (
  masking_policy_id varchar2,
  generate_masking_report_for_download_details dbms_cloud_oci_datasafe_generate_masking_report_for_download_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_masking_report_for_download_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`generate_masking_report_for_download_details`	(required) Details to generate a downloadable masking report.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_ON_PREM_CONNECTOR_CONFIGURATION Function

Creates and downloads the configuration of the specified on-premises connector.

Syntax

FUNCTION generate_on_prem_connector_configuration (
  generate_on_prem_connector_configuration_details dbms_cloud_oci_datasafe_generate_on_prem_connector_configuration_details_t,
  on_prem_connector_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_on_prem_connector_configuration_response_t;

Parameters

Parameter	Description
`generate_on_prem_connector_configuration_details`	(required) The details used to create and download on-premises connector's configuration.
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_REPORT Function

Generates a .xls or .pdf report based on parameters and report definition.

Syntax

FUNCTION generate_report (
  report_definition_id varchar2,
  generate_report_details dbms_cloud_oci_datasafe_generate_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_report_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`generate_report_details`	(required) Details for report generation. It contains details such as PDF/XLS and filter parameters like audit event time limits, number of rows and target databases etc
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(dateGenerated ge '2021-12-18T01-00-26') and (ilmTarget eq 'dscs-target')
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_SECURITY_ASSESSMENT_REPORT Function

Generates the report of the specified security assessment. You can get the report in PDF or XLS format. After generating the report, use DownloadSecurityAssessmentReport to download it in the preferred format.

Syntax

FUNCTION generate_security_assessment_report (
  security_assessment_id varchar2,
  generate_security_assessment_report_details dbms_cloud_oci_datasafe_generate_security_assessment_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_security_assessment_report_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`generate_security_assessment_report_details`	(required) Details of the report.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD Function

Generates a downloadable file corresponding to the specified sensitive data model. It's a prerequisite for the DownloadSensitiveDataModel operation. Use this endpoint to generate a data model file and then use DownloadSensitiveDataModel to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Syntax

FUNCTION generate_sensitive_data_model_for_download (
  sensitive_data_model_id varchar2,
  generate_sensitive_data_model_for_download_details dbms_cloud_oci_datasafe_generate_sensitive_data_model_for_download_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_sensitive_data_model_for_download_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`generate_sensitive_data_model_for_download_details`	(required) Details to generate a sensitive data model file.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_SQL_FIREWALL_POLICY Function

Generates or appends to the SQL Firewall policy using the specified SQL collection.

Syntax

FUNCTION generate_sql_firewall_policy (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_sql_firewall_policy_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_USER_ASSESSMENT_REPORT Function

Generates the report of the specified user assessment. The report is available in PDF or XLS format. After generating the report, use DownloadUserAssessmentReport to download it in the preferred format.

Syntax

FUNCTION generate_user_assessment_report (
  user_assessment_id varchar2,
  generate_user_assessment_report_details dbms_cloud_oci_datasafe_generate_user_assessment_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_generate_user_assessment_report_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`generate_user_assessment_report_details`	(required) Details of the report.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ALERT Function

Gets the details of the specified alerts.

Syntax

FUNCTION get_alert (
  alert_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_alert_response_t;

Parameters

Parameter	Description
`alert_id`	(required) The OCID of alert.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ALERT_POLICY Function

Gets the details of alert policy by its ID.

Syntax

FUNCTION get_alert_policy (
  alert_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_alert_policy_response_t;

Parameters

Parameter	Description
`alert_policy_id`	(required) The OCID of the alert policy.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUDIT_ARCHIVE_RETRIEVAL Function

Gets the details of the specified archive retreival.

Syntax

FUNCTION get_audit_archive_retrieval (
  audit_archive_retrieval_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_audit_archive_retrieval_response_t;

Parameters

Parameter	Description
`audit_archive_retrieval_id`	(required) OCID of the archive retrieval.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUDIT_POLICY Function

Gets a audit policy by identifier.

Syntax

FUNCTION get_audit_policy (
  audit_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_audit_policy_response_t;

Parameters

Parameter	Description
`audit_policy_id`	(required) Unique audit policy identifier.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUDIT_PROFILE Function

Gets the details of audit profile resource and associated audit trails of the audit profile.

Syntax

FUNCTION get_audit_profile (
  audit_profile_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_audit_profile_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUDIT_TRAIL Function

Gets the details of audit trail.

Syntax

FUNCTION get_audit_trail (
  audit_trail_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_audit_trail_response_t;

Parameters

Parameter	Description
`audit_trail_id`	(required) The OCID of the audit trail.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_COMPATIBLE_FORMATS_FOR_DATA_TYPES Function

Gets a list of basic masking formats compatible with the supported data types. The data types are grouped into the following categories - Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2 Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE Date - Includes DATE and TIMESTAMP LOB - Includes BLOB, CLOB, and NCLOB All - Includes all the supported data types

Syntax

FUNCTION get_compatible_formats_for_data_types (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_compatible_formats_for_data_types_response_t;

Parameters

Parameter	Description
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_COMPATIBLE_FORMATS_FOR_SENSITIVE_TYPES Function

Gets a list of library masking formats compatible with the existing sensitive types. For each sensitive type, it returns the assigned default masking format as well as the other library masking formats that have the sensitiveTypeIds attribute containing the OCID of the sensitive type.

Syntax

FUNCTION get_compatible_formats_for_sensitive_types (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_compatible_formats_for_sensitive_types_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATA_SAFE_CONFIGURATION Function

Gets the details of the Data Safe configuration.

Syntax

FUNCTION get_data_safe_configuration (
  compartment_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_data_safe_configuration_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) A filter to return only resources that match the specified compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATA_SAFE_PRIVATE_ENDPOINT Function

Gets the details of the specified Data Safe private endpoint.

Syntax

FUNCTION get_data_safe_private_endpoint (
  data_safe_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_data_safe_private_endpoint_response_t;

Parameters

Parameter	Description
`data_safe_private_endpoint_id`	(required) The OCID of the private endpoint.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_SECURITY_CONFIG Function

Gets a database security configuration by identifier.

Syntax

FUNCTION get_database_security_config (
  database_security_config_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_database_security_config_response_t;

Parameters

Parameter	Description
`database_security_config_id`	(required) The OCID of the database security configuration resource.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DIFFERENCE_COLUMN Function

Gets the details of the specified SDM Masking policy difference column.

Syntax

FUNCTION get_difference_column (
  sdm_masking_policy_difference_id varchar2,
  difference_column_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_difference_column_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`difference_column_key`	(required) The unique key that identifies the difference column.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DISCOVERY_JOB Function

Gets the details of the specified discovery job.

Syntax

FUNCTION get_discovery_job (
  discovery_job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_discovery_job_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DISCOVERY_JOB_RESULT Function

Gets the details of the specified discovery result.

Syntax

FUNCTION get_discovery_job_result (
  discovery_job_id varchar2,
  result_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_discovery_job_result_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`result_key`	(required) The unique key that identifies the discovery result.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_LIBRARY_MASKING_FORMAT Function

Gets the details of the specified library masking format.

Syntax

FUNCTION get_library_masking_format (
  library_masking_format_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_library_masking_format_response_t;

Parameters

Parameter	Description
`library_masking_format_id`	(required) The OCID of the library masking format.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MASKING_COLUMN Function

Gets the details of the specified masking column.

Syntax

FUNCTION get_masking_column (
  masking_policy_id varchar2,
  masking_column_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_masking_column_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`masking_column_key`	(required) The unique key that identifies the masking column. It's numeric and unique within a masking policy.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MASKING_POLICY Function

Gets the details of the specified masking policy.

Syntax

FUNCTION get_masking_policy (
  masking_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_masking_policy_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MASKING_REPORT Function

Gets the details of the specified masking report.

Syntax

FUNCTION get_masking_report (
  masking_report_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_masking_report_response_t;

Parameters

Parameter	Description
`masking_report_id`	(required) The OCID of the masking report.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ON_PREM_CONNECTOR Function

Gets the details of the specified on-premises connector.

Syntax

FUNCTION get_on_prem_connector (
  on_prem_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_on_prem_connector_response_t;

Parameters

Parameter	Description
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PROFILE Function

Lists the details of given profile available on the target. The GetProfile operation returns only the profiles in the specified 'userAssessmentId'. This does not include any subcompartments of the current compartment.

Syntax

FUNCTION get_profile (
  user_assessment_id varchar2,
  profile_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_profile_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`profile_name`	(required) Profile name to get detailed information .
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPORT Function

Gets a report by identifier

Syntax

FUNCTION get_report (
  report_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_report_response_t;

Parameters

Parameter	Description
`report_id`	(required) Unique report identifier
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPORT_CONTENT Function

Downloads the specified report in the form of .xls or .pdf.

Syntax

FUNCTION get_report_content (
  report_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_report_content_response_t;

Parameters

Parameter	Description
`report_id`	(required) Unique report identifier
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPORT_DEFINITION Function

Gets the details of report definition specified by the identifier

Syntax

FUNCTION get_report_definition (
  report_definition_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_report_definition_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SDM_MASKING_POLICY_DIFFERENCE Function

Gets the details of the specified SDM Masking policy difference.

Syntax

FUNCTION get_sdm_masking_policy_difference (
  sdm_masking_policy_difference_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sdm_masking_policy_difference_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_ASSESSMENT Function

Gets the details of the specified security assessment.

Syntax

FUNCTION get_security_assessment (
  security_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_security_assessment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_ASSESSMENT_COMPARISON Function

Gets the details of the comparison report for the security assessments submitted for comparison.

Syntax

FUNCTION get_security_assessment_comparison (
  security_assessment_id varchar2,
  comparison_security_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_security_assessment_comparison_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`comparison_security_assessment_id`	(required) The OCID of the security assessment baseline.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_POLICY Function

Gets a security policy by the specified OCID of the security policy resource.

Syntax

FUNCTION get_security_policy (
  security_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_security_policy_response_t;

Parameters

Parameter	Description
`security_policy_id`	(required) The OCID of the security policy resource.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_POLICY_DEPLOYMENT Function

Gets a security policy deployment by identifier.

Syntax

FUNCTION get_security_policy_deployment (
  security_policy_deployment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_security_policy_deployment_response_t;

Parameters

Parameter	Description
`security_policy_deployment_id`	(required) The OCID of the security policy deployment resource.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_POLICY_ENTRY_STATE Function

Gets a security policy entity states by identifier.

Syntax

FUNCTION get_security_policy_entry_state (
  security_policy_deployment_id varchar2,
  security_policy_entry_state_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_security_policy_entry_state_response_t;

Parameters

Parameter	Description
`security_policy_deployment_id`	(required) The OCID of the security policy deployment resource.
`security_policy_entry_state_id`	(required) Unique security policy entry state identifier. The unique id for a given security policy entry state can be obtained from the list api by passing the OCID of the corresponding security policy deployment resource as the query parameter.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SENSITIVE_COLUMN Function

Gets the details of the specified sensitive column.

Syntax

FUNCTION get_sensitive_column (
  sensitive_data_model_id varchar2,
  sensitive_column_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sensitive_column_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`sensitive_column_key`	(required) The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SENSITIVE_DATA_MODEL Function

Gets the details of the specified sensitive data model.

Syntax

FUNCTION get_sensitive_data_model (
  sensitive_data_model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sensitive_data_model_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SENSITIVE_TYPE Function

Gets the details of the specified sensitive type.

Syntax

FUNCTION get_sensitive_type (
  sensitive_type_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sensitive_type_response_t;

Parameters

Parameter	Description
`sensitive_type_id`	(required) The OCID of the sensitive type.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SQL_COLLECTION Function

Gets a SQL collection by identifier.

Syntax

FUNCTION get_sql_collection (
  sql_collection_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sql_collection_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SQL_FIREWALL_POLICY Function

Gets a SQL Firewall policy by identifier.

Syntax

FUNCTION get_sql_firewall_policy (
  sql_firewall_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_sql_firewall_policy_response_t;

Parameters

Parameter	Description
`sql_firewall_policy_id`	(required) The OCID of the SQL Firewall policy resource.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TARGET_ALERT_POLICY_ASSOCIATION Function

Gets the details of target-alert policy association by its ID.

Syntax

FUNCTION get_target_alert_policy_association (
  target_alert_policy_association_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_target_alert_policy_association_response_t;

Parameters

Parameter	Description
`target_alert_policy_association_id`	(required) The OCID of the target-alert policy association.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TARGET_DATABASE Function

Returns the details of the specified Data Safe target database.

Syntax

FUNCTION get_target_database (
  target_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_target_database_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_USER_ASSESSMENT Function

Gets a user assessment by identifier.

Syntax

FUNCTION get_user_assessment (
  user_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_user_assessment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_USER_ASSESSMENT_COMPARISON Function

Gets the details of the comparison report for the user assessments submitted for comparison.

Syntax

FUNCTION get_user_assessment_comparison (
  user_assessment_id varchar2,
  comparison_user_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_user_assessment_comparison_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`comparison_user_assessment_id`	(required) The OCID of the baseline user assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the details of the specified work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALERT_ANALYTICS Function

Returns the aggregation details of the alerts.

Syntax

FUNCTION list_alert_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  time_started timestamp with time zone DEFAULT NULL,
  time_ended timestamp with time zone DEFAULT NULL,
  query_time_zone varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  summary_field dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_alert_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`time_started`	(optional) An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.
`time_ended`	(optional) An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.
`query_time_zone`	(optional) Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. Allowed values are: 'displayName', 'timeCreated'
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: \| query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq \"user\") and (targetNames eq \"target_1\") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)
`summary_field`	(optional) Specifies a subset of summarized fields to be returned in the response. Allowed values are: 'alertType', 'targetIds', 'targetNames', 'alertSeverity', 'alertStatus', 'timeCreated', 'policyId', 'open', 'closed', 'critical', 'high', 'medium', 'low', 'alertcount'
`group_by`	(optional) A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. Allowed values are: 'alertType', 'targetIds', 'targetNames', 'alertSeverity', 'alertStatus', 'timeCreated', 'policyId'
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALERT_POLICIES Function

Gets a list of all alert policies.

Syntax

FUNCTION list_alert_policies (
  compartment_id varchar2,
  alert_policy_id varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  is_user_defined number DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_alert_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`alert_policy_id`	(optional) A filter to return policy by it's OCID.
`l_type`	(optional) An optional filter to return only alert policies of a certain type. Allowed values are: 'AUDITING', 'SECURITY_ASSESSMENT', 'USER_ASSESSMENT'
`is_user_defined`	(optional) An optional filter to return only alert policies that are user-defined or not.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`lifecycle_state`	(optional) An optional filter to return only alert policies that have the given life-cycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort parameter may be provided. Allowed values are: 'displayName', 'timeCreated'
`opc_request_id`	(optional) Unique identifier for the request.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALERT_POLICY_RULES Function

Lists the rules of the specified alert policy. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.

Syntax

FUNCTION list_alert_policy_rules (
  alert_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_alert_policy_rules_response_t;

Parameters

Parameter	Description
`alert_policy_id`	(required) The OCID of the alert policy.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALERTS Function

Gets a list of all alerts.

Syntax

FUNCTION list_alerts (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  field dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_alerts_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`id`	(optional) A filter to return alert by it's OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. Allowed values are: 'displayName', 'timeCreated'
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: \| query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq \"user\") and (targetNames eq \"target_1\") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)
`field`	(optional) Specifies a subset of fields to be returned in the response. Allowed values are: 'id', 'displayName', 'alertType', 'targetIds', 'targetNames', 'severity', 'status', 'operationTime', 'operation', 'operationStatus', 'timeCreated', 'timeUpdated', 'policyId', 'lifecycleState'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_ARCHIVE_RETRIEVALS Function

Returns the list of audit archive retrieval.

Syntax

FUNCTION list_audit_archive_retrievals (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  audit_archive_retrieval_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_of_expiry timestamp with time zone DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_archive_retrievals_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`audit_archive_retrieval_id`	(optional) OCID of the archive retrieval.
`target_id`	(optional) The OCID of the target associated with the archive retrieval.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only resources that matches the specified lifecycle state. Allowed values are: 'CREATING', 'ACTIVE', 'NEEDS_ATTENTION', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'
`time_of_expiry`	(optional) The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_EVENT_ANALYTICS Function

By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the `summaryField` query parameter. **Example:** /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge \"2021-06-13T23:49:14\") /ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc. /ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

Syntax

FUNCTION list_audit_event_analytics (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  summary_field dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  time_started timestamp with time zone DEFAULT NULL,
  time_ended timestamp with time zone DEFAULT NULL,
  query_time_zone varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_event_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`limit`	(optional) For details about how pagination works, see List Pagination.
`page`	(optional) It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')
`summary_field`	(optional) Specifies a subset of summarized fields to be returned in the response. Allowed values are: 'auditEventTime', 'dbUserName', 'targetId', 'targetName', 'targetClass', 'objectType', 'clientHostname', 'clientProgram', 'clientId', 'auditType', 'eventName', 'allRecord', 'auditSettingsChange', 'dbSchemaChange', 'entitlementChange', 'loginFailure', 'loginSuccess', 'allViolations', 'realmViolations', 'ruleViolations', 'dvconfigActivities', 'ddls', 'dmls', 'privilegeChanges', 'auditSettingsEnables', 'auditSettingsDisables', 'selects', 'creates', 'alters', 'drops', 'grants', 'revokes'
`time_started`	(optional) An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.
`time_ended`	(optional) An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.
`query_time_zone`	(optional) Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.
`group_by`	(optional) A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. Allowed values are: 'auditEventTime', 'dbUserName', 'targetId', 'targetName', 'targetClass', 'objectType', 'clientHostname', 'clientProgram', 'clientId', 'auditType', 'eventName'
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) If this query parameter is specified, the result is ordered based on this query parameter value. Allowed values are: 'targetId', 'targetClass', 'targetName', 'objectType', 'dbUserName', 'eventName', 'auditEventTime', 'clientHostname', 'clientProgram', 'clientId', 'auditType'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_EVENTS Function

The ListAuditEvents operation returns specified `compartmentId` audit Events only. The list does not include any audit Events associated with the `subcompartments` of the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListAuditEvents on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_events (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_events_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For details about how pagination works, see List Pagination.
`page`	(optional) It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(operationTime ge '2021-06-04T01-00-26') and (eventName eq 'LOGON')
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) If this query parameter is specified, the result is sorted by this query parameter value. Allowed values are: 'dbUserName', 'targetName', 'databaseType', 'targetClass', 'auditEventTime', 'timeCollected', 'osUserName', 'operation', 'operationStatus', 'eventName', 'errorCode', 'errorMessage', 'objectType', 'objectName', 'objectOwner', 'clientHostname', 'clientIp', 'isAlerted', 'actionTaken', 'clientProgram', 'commandText', 'commandParam', 'extendedEventAttributes', 'auditLocation', 'osTerminal', 'clientId', 'auditPolicies', 'auditType'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_POLICIES Function

Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions. The ListAuditPolicies operation returns only the audit policies in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListAuditPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_policies (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  audit_policy_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`lifecycle_state`	(optional) The current state of the audit policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'FAILED', 'NEEDS_ATTENTION', 'DELETING', 'DELETED'
`audit_policy_id`	(optional) An optional filter to return only resources that match the specified id.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_POLICY_ANALYTICS Function

Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform SummarizedAuditPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. **Example:** ListAuditPolicyAnalytics?groupBy=auditPolicyCategory

Syntax

FUNCTION list_audit_policy_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  audit_policy_category varchar2 DEFAULT NULL,
  audit_policy_name varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_policy_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`group_by`	(optional) The group by parameter to summarize audit policy aggregation. Allowed values are: 'auditPolicyCategory', 'auditPolicyName', 'targetId'
`audit_policy_category`	(optional) The category to which the audit policy belongs to. Allowed values are: 'BASIC_ACTIVITY', 'ADMIN_USER_ACTIVITY', 'USER_ACTIVITY', 'ORACLE_PREDEFINED', 'COMPLIANCE_STANDARD', 'CUSTOM', 'SQL_FIREWALL_AUDITING'
`audit_policy_name`	(optional) In case of seeded policies, it is the policy name defined by Data Safe. In case of custom Policies, it is the policy name that is used to create the policies on the target database. In case of Oracle Pre-seeded policies, it is the default policy name of the same.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`lifecycle_state`	(optional) The current state of the audit policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'FAILED', 'NEEDS_ATTENTION', 'DELETING', 'DELETED'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_PROFILE_ANALYTICS Function

Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles. As an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform AuditProfileAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_profile_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_profile_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`group_by`	(optional) The group by parameter for summarize operation on audit. Allowed values are: 'isPaidUsageEnabled'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_PROFILES Function

Gets a list of all audit profiles. The ListAuditProfiles operation returns only the audit profiles in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListAuditProfiles on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_profiles (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  audit_profile_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  is_override_global_retention_setting number DEFAULT NULL,
  is_paid_usage_enabled number DEFAULT NULL,
  audit_collected_volume_greater_than_or_equal_to number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_profiles_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`audit_profile_id`	(optional) A optional filter to return only resources that match the specified id.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A optional filter to return only resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'FAILED', 'NEEDS_ATTENTION', 'DELETED'
`is_override_global_retention_setting`	(optional) A optional filter to return only resources that match the specified retention configured value.
`is_paid_usage_enabled`	(optional) Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
`audit_collected_volume_greater_than_or_equal_to`	(optional) A filter to return only items that have count of audit records collected greater than or equal to the specified value.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_TRAIL_ANALYTICS Function

Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails. As an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform AuditTrailAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_trail_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_trail_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`group_by`	(optional) The group by parameter for summarize operation on audit trail. Allowed values are: 'location', 'lifecycleState', 'status', 'targetId'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUDIT_TRAILS Function

Gets a list of all audit trails. The ListAuditTrails operation returns only the audit trails in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListAuditTrails on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_audit_trails (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  audit_trail_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_audit_trails_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`audit_trail_id`	(optional) A optional filter to return only resources that match the specified id.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A optional filter to return only resources that match the specified lifecycle state. Allowed values are: 'INACTIVE', 'UPDATING', 'ACTIVE', 'DELETING', 'FAILED', 'NEEDS_ATTENTION'
`status`	(optional) A optional filter to return only resources that match the specified sub-state of audit trail. Allowed values are: 'STARTING', 'COLLECTING', 'RECOVERING', 'IDLE', 'STOPPING', 'STOPPED', 'RESUMING', 'RETRYING', 'NOT_STARTED', 'STOPPED_NEEDS_ATTN', 'STOPPED_FAILED'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AVAILABLE_AUDIT_VOLUMES Function

Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.

Syntax

FUNCTION list_available_audit_volumes (
  audit_profile_id varchar2,
  work_request_id varchar2,
  trail_location varchar2 DEFAULT NULL,
  month_in_consideration_greater_than timestamp with time zone DEFAULT NULL,
  month_in_consideration_less_than timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_available_audit_volumes_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`work_request_id`	(required) The OCID of the work request.
`trail_location`	(optional) The audit trail location.
`month_in_consideration_greater_than`	(optional) Specifying `monthInConsiderationGreaterThan` parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T00:00:00.000Z
`month_in_consideration_less_than`	(optional) Specifying `monthInConsiderationLessThan` parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T00:00:00.000Z
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. Allowed values are: 'monthInConsideration', 'volume', 'trailLocation'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_COLLECTED_AUDIT_VOLUMES Function

Gets a list of all collected audit volume data points.

Syntax

FUNCTION list_collected_audit_volumes (
  audit_profile_id varchar2,
  work_request_id varchar2,
  month_in_consideration_greater_than timestamp with time zone DEFAULT NULL,
  month_in_consideration_less_than timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_collected_audit_volumes_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`work_request_id`	(required) The OCID of the work request.
`month_in_consideration_greater_than`	(optional) Specifying `monthInConsiderationGreaterThan` parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T00:00:00.000Z
`month_in_consideration_less_than`	(optional) Specifying `monthInConsiderationLessThan` parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T00:00:00.000Z
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. Allowed values are: 'monthInConsideration', 'onlineVolume', 'archivedVolume'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_COLUMNS Function

Returns a list of column metadata objects.

Syntax

FUNCTION list_columns (
  target_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  table_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  datatype dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  schema_name_contains varchar2 DEFAULT NULL,
  table_name_contains varchar2 DEFAULT NULL,
  column_name_contains varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_columns_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`table_name`	(optional) A filter to return only items related to specific table name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`datatype`	(optional) A filter to return only items related to specific datatype.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. Allowed values are: 'SCHEMANAME', 'TABLENAME', 'COLUMNNAME', 'DATATYPE'
`schema_name_contains`	(optional) A filter to return only items if schema name contains a specific string.
`table_name_contains`	(optional) A filter to return only items if table name contains a specific string.
`column_name_contains`	(optional) A filter to return only items if column name contains a specific string.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATA_SAFE_PRIVATE_ENDPOINTS Function

Gets a list of Data Safe private endpoints.

Syntax

FUNCTION list_data_safe_private_endpoints (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_data_safe_private_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`vcn_id`	(optional) A filter to return only resources that match the specified VCN OCID.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NA'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_SECURITY_CONFIGS Function

Retrieves a list of all database security configurations in Data Safe. The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListDatabaseSecurityConfigs on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_database_security_configs (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  database_security_config_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_database_security_configs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the database security configuration. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'FAILED', 'NEEDS_ATTENTION', 'DELETING', 'DELETED'
`database_security_config_id`	(optional) An optional filter to return only resources that match the specified OCID of the database security configuration resource.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DIFFERENCE_COLUMNS Function

Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.

Syntax

FUNCTION list_difference_columns (
  sdm_masking_policy_difference_id varchar2,
  difference_type varchar2 DEFAULT NULL,
  planned_action varchar2 DEFAULT NULL,
  sync_status varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_difference_columns_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`difference_type`	(optional) A filter to return only the SDM masking policy difference columns that match the specified difference type
`planned_action`	(optional) A filter to return only the SDM masking policy difference columns that match the specified planned action.
`sync_status`	(optional) A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for schemaName is descending. The default order for differenceType, schemaName, objectName, columnName and plannedAction is ascending. Allowed values are: 'differenceType', 'schemaName', 'objectName', 'columnName', 'plannedAction'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DISCOVERY_ANALYTICS Function

Gets consolidated discovery analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel \"ACCESSIBLE\" by default.

Syntax

FUNCTION list_discovery_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  group_by varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  sensitive_data_model_id varchar2 DEFAULT NULL,
  sensitive_type_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_common number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_discovery_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`group_by`	(optional) Attribute by which the discovery analytics data should be grouped. Allowed values are: 'targetId', 'sensitiveDataModelId', 'sensitiveTypeId', 'targetIdAndSensitiveDataModelId', 'sensitiveTypeIdAndTargetId', 'sensitiveTypeIdAndSensitiveDataModelId'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`sensitive_data_model_id`	(optional) A filter to return only the resources that match the specified sensitive data model OCID.
`sensitive_type_id`	(optional) A filter to return only items related to a specific sensitive type OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`is_common`	(optional) A filter to return only the common sensitive type resources. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DISCOVERY_JOB_RESULTS Function

Gets a list of discovery results based on the specified query parameters.

Syntax

FUNCTION list_discovery_job_results (
  discovery_job_id varchar2,
  discovery_type varchar2 DEFAULT NULL,
  planned_action varchar2 DEFAULT NULL,
  is_result_applied number DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_discovery_job_results_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`discovery_type`	(optional) A filter to return only the resources that match the specified discovery type.
`planned_action`	(optional) A filter to return only the resources that match the specified planned action.
`is_result_applied`	(optional) A filter to return the discovery result resources based on the value of their isResultApplied attribute.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending. Allowed values are: 'discoveryType', 'timeFinished', 'schemaName', 'objectName', 'columnName', 'plannedAction'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DISCOVERY_JOBS Function

Gets a list of incremental discovery jobs based on the specified query parameters.

Syntax

FUNCTION list_discovery_jobs (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  discovery_job_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sensitive_data_model_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_discovery_jobs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`discovery_job_id`	(optional) A filter to return only the resources that match the specified discovery job OCID.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`sensitive_data_model_id`	(optional) A filter to return only the resources that match the specified sensitive data model OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. Allowed values are: 'timeStarted', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FINDINGS Function

List all the findings from all the targets in the specified compartment.

Syntax

FUNCTION list_findings (
  security_assessment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  severity varchar2 DEFAULT NULL,
  references varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  finding_key varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_findings_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`opc_request_id`	(optional) Unique identifier for the request.
`severity`	(optional) A filter to return only findings of a particular risk level. Allowed values are: 'HIGH', 'MEDIUM', 'LOW', 'EVALUATE', 'ADVISORY', 'PASS'
`references`	(optional) An optional filter to return only findings that match the specified reference. Allowed values are: 'STIG', 'CIS', 'GDPR'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`finding_key`	(optional) Each finding in security assessment has an associated key (think of key as a finding's name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_GRANTS Function

Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the privilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to roles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers to get the userKey for a particular user.

Syntax

FUNCTION list_grants (
  user_assessment_id varchar2,
  user_key varchar2,
  grant_key varchar2 DEFAULT NULL,
  grant_name varchar2 DEFAULT NULL,
  privilege_type varchar2 DEFAULT NULL,
  privilege_category varchar2 DEFAULT NULL,
  depth_level number DEFAULT NULL,
  depth_level_greater_than_or_equal_to number DEFAULT NULL,
  depth_level_less_than number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_grants_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`user_key`	(required) The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user.
`grant_key`	(optional) A filter to return only items that match the specified user grant key.
`grant_name`	(optional) A filter to return only items that match the specified user grant name.
`privilege_type`	(optional) A filter to return only items that match the specified privilege grant type.
`privilege_category`	(optional) A filter to return only items that match the specified user privilege category.
`depth_level`	(optional) A filter to return only items that match the specified user grant depth level.
`depth_level_greater_than_or_equal_to`	(optional) A filter to return only items that are at a level greater than or equal to the specified user grant depth level.
`depth_level_less_than`	(optional) A filter to return only items that are at a level less than the specified user grant depth level.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending. Allowed values are: 'grantName', 'grantType', 'privilegeCategory', 'depthLevel', 'key'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_LIBRARY_MASKING_FORMATS Function

Gets a list of library masking formats based on the specified query parameters.

Syntax

FUNCTION list_library_masking_formats (
  compartment_id varchar2,
  library_masking_format_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  library_masking_format_source varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_library_masking_formats_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`library_masking_format_id`	(optional) A filter to return only the resources that match the specified library masking format OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle states. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'NEEDS_ATTENTION', 'FAILED'
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`library_masking_format_source`	(optional) A filter to return the library masking format resources based on the value of their source attribute. Allowed values are: 'ORACLE', 'USER'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. Allowed values are: 'displayName', 'timeCreated'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKED_COLUMNS Function

Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

Syntax

FUNCTION list_masked_columns (
  masking_report_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  masking_column_group dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sensitive_type_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masked_columns_response_t;

Parameters

Parameter	Description
`masking_report_id`	(required) The OCID of the masking report.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. Allowed values are: 'schemaName', 'objectName'
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`object_type`	(optional) A filter to return only items related to a specific object type. Allowed values are: 'ALL', 'TABLE', 'EDITIONING_VIEW'
`masking_column_group`	(optional) A filter to return only the resources that match the specified masking column group.
`sensitive_type_id`	(optional) A filter to return only items related to a specific sensitive type OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_ANALYTICS Function

Gets consolidated masking analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel \"ACCESSIBLE\" by default.

Syntax

FUNCTION list_masking_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  group_by varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  masking_policy_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`group_by`	(optional) Attribute by which the masking analytics data should be grouped. Allowed values are: 'targetId', 'policyId'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`masking_policy_id`	(optional) A filter to return only the resources that match the specified masking policy OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_COLUMNS Function

Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.

Syntax

FUNCTION list_masking_columns (
  masking_policy_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  masking_column_lifecycle_state varchar2 DEFAULT NULL,
  data_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  masking_column_group dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sensitive_type_id varchar2 DEFAULT NULL,
  is_masking_enabled number DEFAULT NULL,
  is_seed_required number DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  time_updated_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_updated_less_than timestamp with time zone DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_columns_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending. Allowed values are: 'timeCreated', 'schemaName', 'objectName', 'dataType'
`masking_column_lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle states. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'NEEDS_ATTENTION', 'FAILED'
`data_type`	(optional) A filter to return only resources that match the specified data types. Allowed values are: 'CHARACTER', 'DATE', 'LOB', 'NUMERIC'
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`object_type`	(optional) A filter to return only items related to a specific object type. Allowed values are: 'ALL', 'TABLE', 'EDITIONING_VIEW'
`masking_column_group`	(optional) A filter to return only the resources that match the specified masking column group.
`sensitive_type_id`	(optional) A filter to return only items related to a specific sensitive type OCID.
`is_masking_enabled`	(optional) A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.
`is_seed_required`	(optional) A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`time_updated_greater_than_or_equal_to`	(optional) Search for resources that were updated after a specific date. Specifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo` parameter will retrieve all resources updated after the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.
`time_updated_less_than`	(optional) Search for resources that were updated before a specific date. Specifying this parameter corresponding `timeUpdatedLessThan` parameter will retrieve all resources updated before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_OBJECTS Function

Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.

Syntax

FUNCTION list_masking_objects (
  masking_policy_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_objects_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. Allowed values are: 'schemaName', 'objectName', 'objectType'
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`object_type`	(optional) A filter to return only items related to a specific object type. Allowed values are: 'ALL', 'TABLE', 'EDITIONING_VIEW'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_POLICIES Function

Gets a list of masking policies based on the specified query parameters.

Syntax

FUNCTION list_masking_policies (
  compartment_id varchar2,
  masking_policy_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sensitive_data_model_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`masking_policy_id`	(optional) A filter to return only the resources that match the specified masking policy OCID.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle states. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'NEEDS_ATTENTION', 'FAILED'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. Allowed values are: 'displayName', 'timeCreated'
`sensitive_data_model_id`	(optional) A filter to return only the resources that match the specified sensitive data model OCID.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_REPORTS Function

Gets a list of masking reports based on the specified query parameters.

Syntax

FUNCTION list_masking_reports (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  masking_policy_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_reports_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`masking_policy_id`	(optional) A filter to return only the resources that match the specified masking policy OCID.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. Allowed values are: 'timeMaskingFinished'
`opc_request_id`	(optional) Unique identifier for the request.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MASKING_SCHEMAS Function

Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.

Syntax

FUNCTION list_masking_schemas (
  masking_policy_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_masking_schemas_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. Allowed values are: 'schemaName'
`schema_name`	(optional) A filter to return only items related to specific schema name.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ON_PREM_CONNECTORS Function

Gets a list of on-premises connectors.

Syntax

FUNCTION list_on_prem_connectors (
  compartment_id varchar2,
  on_prem_connector_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  on_prem_connector_lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_on_prem_connectors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`on_prem_connector_id`	(optional) A filter to return only the on-premises connector that matches the specified id.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`on_prem_connector_lifecycle_state`	(optional) A filter to return only on-premises connector resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROFILE_ANALYTICS Function

Gets a list of aggregated user profile details in the specified compartment. This provides information about the overall profiles available. For example, the user profile details include how many users have the profile assigned and do how many use password verification function. This data is especially useful content for dashboards or to support analytics. When you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned. The parameter compartmentIdInSubtree applies when you perform ListProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To use ListProfileAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Syntax

FUNCTION list_profile_analytics (
  user_assessment_id varchar2,
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  profile_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_profile_analytics_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`profile_name`	(optional) A filter to return only items that match the specified profile name.
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROFILE_SUMMARIES Function

Gets a list of user profiles containing the profile details along with the target id and user counts. The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration. The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'. The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.

Syntax

FUNCTION list_profile_summaries (
  user_assessment_id varchar2,
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  profile_name varchar2 DEFAULT NULL,
  is_user_created number DEFAULT NULL,
  password_verification_function varchar2 DEFAULT NULL,
  user_count_greater_than_or_equal varchar2 DEFAULT NULL,
  user_count_less_than varchar2 DEFAULT NULL,
  failed_login_attempts_greater_than_or_equal varchar2 DEFAULT NULL,
  failed_login_attempts_less_than varchar2 DEFAULT NULL,
  sessions_per_user_greater_than_or_equal varchar2 DEFAULT NULL,
  sessions_per_user_less_than varchar2 DEFAULT NULL,
  inactive_account_time_greater_than_or_equal varchar2 DEFAULT NULL,
  inactive_account_time_less_than varchar2 DEFAULT NULL,
  password_lock_time_greater_than_or_equal varchar2 DEFAULT NULL,
  password_lock_time_less_than varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_profile_summaries_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`profile_name`	(optional) A filter to return only items that match the specified profile name.
`is_user_created`	(optional) An optional filter to return the user created profiles.
`password_verification_function`	(optional) An optional filter to filter the profiles based on password verification function.
`user_count_greater_than_or_equal`	(optional) An optional filter to return the profiles having user count greater than or equal to the provided value.
`user_count_less_than`	(optional) An optional filter to return the profiles having user count less than the provided value.
`failed_login_attempts_greater_than_or_equal`	(optional) An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`failed_login_attempts_less_than`	(optional) An optional filter to return the profiles having failed login attempts number less than the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`sessions_per_user_greater_than_or_equal`	(optional) An optional filter to return the profiles permitting the user to spawn multiple sessions having count. greater than or equal to the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`sessions_per_user_less_than`	(optional) An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`inactive_account_time_greater_than_or_equal`	(optional) An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`inactive_account_time_less_than`	(optional) An optional filter to return the profiles allowing inactive account time in days less than the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`password_lock_time_greater_than_or_equal`	(optional) An optional filter to return the profiles having password lock number greater than or equal to the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`password_lock_time_less_than`	(optional) An optional filter to return the profiles having password lock number less than the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.
`sort_by`	(optional) The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC. Allowed values are: 'profileName', 'targetId', 'isUserCreated', 'passwordVerificationFunction', 'userCount', 'sessionsPerUser', 'inactiveAccountTime', 'passwordLockTime', 'failedLoginAttempts'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REPORT_DEFINITIONS Function

Gets a list of report definitions. The ListReportDefinitions operation returns only the report definitions in the specified `compartmentId`. It also returns the seeded report definitions which are available to all the compartments.

Syntax

FUNCTION list_report_definitions (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_seeded number DEFAULT NULL,
  data_source varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  category varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_report_definitions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) The name of the report definition to query.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'DISPLAYORDER'
`opc_request_id`	(optional) Unique identifier for the request.
`is_seeded`	(optional) A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
`data_source`	(optional) Specifies the name of a resource that provides data for the report. For example alerts, events. Allowed values are: 'EVENTS', 'ALERTS', 'VIOLATIONS', 'ALLOWED_SQL'
`lifecycle_state`	(optional) An optional filter to return only resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED'
`category`	(optional) An optional filter to return only resources that match the specified category. Allowed values are: 'CUSTOM_REPORTS', 'SUMMARY', 'ACTIVITY_AUDITING'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REPORTS Function

Gets a list of all the reports in the compartment. It contains information such as report generation time.

Syntax

FUNCTION list_reports (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  report_definition_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_reports_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) The name of the report definition to query.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. Allowed values are: 'timeGenerated', 'displayName'
`report_definition_id`	(optional) The ID of the report definition to filter the list of reports
`opc_request_id`	(optional) Unique identifier for the request.
`lifecycle_state`	(optional) An optional filter to return only resources that match the specified lifecycle state. Allowed values are: 'UPDATING', 'ACTIVE'
`l_type`	(optional) An optional filter to return only resources that match the specified type. Allowed values are: 'GENERATED', 'SCHEDULED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ROLES Function

Returns a list of role metadata objects.

Syntax

FUNCTION list_roles (
  target_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  role_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  is_oracle_maintained number DEFAULT NULL,
  authentication_type varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  role_name_contains varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_roles_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`role_name`	(optional) A filter to return only a specific role based on role name.
`is_oracle_maintained`	(optional) A filter to return roles based on whether they are maintained by oracle or not.
`authentication_type`	(optional) A filter to return roles based on authentication type.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. Allowed values are: 'ROLENAME'
`role_name_contains`	(optional) A filter to return only items if role name contains a specific string.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SCHEMAS Function

Returns list of schema.

Syntax

FUNCTION list_schemas (
  target_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  is_oracle_maintained number DEFAULT NULL,
  schema_name_contains varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_schemas_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. Allowed values are: 'SCHEMANAME'
`is_oracle_maintained`	(optional) A filter to return only items related to specific type of schema.
`schema_name_contains`	(optional) A filter to return only items if schema name contains a specific string.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SDM_MASKING_POLICY_DIFFERENCES Function

Gets a list of SDM and masking policy difference resources based on the specified query parameters.

Syntax

FUNCTION list_sdm_masking_policy_differences (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  difference_access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sensitive_data_model_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  masking_policy_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sdm_masking_policy_differences_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`difference_access_level`	(optional) Valid value is ACCESSIBLE. Default is ACCESSIBLE. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). Allowed values are: 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`sensitive_data_model_id`	(optional) A filter to return only the resources that match the specified sensitive data model OCID.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle states.
`masking_policy_id`	(optional) A filter to return only the resources that match the specified masking policy OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreationStarted is descending. The default order for displayName is ascending. Allowed values are: 'timeCreationStarted', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SECURITY_ASSESSMENTS Function

Gets a list of security assessments. The ListSecurityAssessments operation returns only the assessments in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSecurityAssessments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_security_assessments (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  schedule_assessment_id varchar2 DEFAULT NULL,
  is_schedule_assessment number DEFAULT NULL,
  triggered_by varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  is_baseline number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_security_assessments_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`l_type`	(optional) A filter to return only items that match the specified security assessment type. Allowed values are: 'LATEST', 'SAVED', 'SAVE_SCHEDULE', 'COMPARTMENT'
`schedule_assessment_id`	(optional) The OCID of the security assessment of type SAVE_SCHEDULE.
`is_schedule_assessment`	(optional) A filter to return only security assessments of type save schedule.
`triggered_by`	(optional) A filter to return only security asessments that were created by either user or system. Allowed values are: 'USER', 'SYSTEM'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`is_baseline`	(optional) A filter to return only the security assessments that are set as a baseline.
`sort_by`	(optional) The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. Allowed values are: 'timeCreated', 'displayName'
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'SUCCEEDED', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SECURITY_POLICIES Function

Retrieves a list of all security policies in Data Safe. The ListSecurityPolicies operation returns only the security policies in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_security_policies (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  security_policy_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_security_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the security policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED'
`security_policy_id`	(optional) An optional filter to return only resources that match the specified OCID of the security policy resource.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SECURITY_POLICY_DEPLOYMENTS Function

Retrieves a list of all security policy deployments in Data Safe. The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicyDeployments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_security_policy_deployments (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  security_policy_deployment_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  security_policy_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_security_policy_deployments_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the security policy deployment. Allowed values are: 'CREATING', 'UPDATING', 'DEPLOYED', 'NEEDS_ATTENTION', 'FAILED', 'DELETING', 'DELETED'
`security_policy_deployment_id`	(optional) An optional filter to return only resources that match the specified OCID of the security policy deployment resource.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`security_policy_id`	(optional) An optional filter to return only resources that match the specified OCID of the security policy resource.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SECURITY_POLICY_ENTRY_STATES Function

Retrieves a list of all security policy entry states in Data Safe. The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.

Syntax

FUNCTION list_security_policy_entry_states (
  security_policy_deployment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  deployment_status varchar2 DEFAULT NULL,
  security_policy_entry_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_security_policy_entry_states_response_t;

Parameters

Parameter	Description
`security_policy_deployment_id`	(required) The OCID of the security policy deployment resource.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`deployment_status`	(optional) The current state of the security policy deployment. Allowed values are: 'CREATED', 'MODIFIED', 'CONFLICT', 'UNAUTHORIZED', 'DELETED'
`security_policy_entry_id`	(optional) An optional filter to return only resources that match the specified security policy entry OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENSITIVE_COLUMNS Function

Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.

Syntax

FUNCTION list_sensitive_columns (
  sensitive_data_model_id varchar2,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  time_updated_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_updated_less_than timestamp with time zone DEFAULT NULL,
  sensitive_column_lifecycle_state varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  data_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  status dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sensitive_type_id dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  parent_column_key dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  relation_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  column_group varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_case_in_sensitive number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sensitive_columns_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`time_updated_greater_than_or_equal_to`	(optional) Search for resources that were updated after a specific date. Specifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo` parameter will retrieve all resources updated after the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.
`time_updated_less_than`	(optional) Search for resources that were updated before a specific date. Specifying this parameter corresponding `timeUpdatedLessThan` parameter will retrieve all resources updated before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.
`sensitive_column_lifecycle_state`	(optional) Filters the sensitive column resources with the given lifecycle state values. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'FAILED'
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`column_name`	(optional) A filter to return only a specific column based on column name.
`object_type`	(optional) A filter to return only items related to a specific object type. Allowed values are: 'ALL', 'TABLE', 'EDITIONING_VIEW'
`data_type`	(optional) A filter to return only the resources that match the specified data types.
`status`	(optional) A filter to return only the sensitive columns that match the specified status. Allowed values are: 'VALID', 'INVALID'
`sensitive_type_id`	(optional) A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs.
`parent_column_key`	(optional) A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys.
`relation_type`	(optional) A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. Allowed values are: 'NONE', 'APP_DEFINED', 'DB_DEFINED'
`column_group`	(optional) A filter to return only the sensitive columns that belong to the specified column group.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. Allowed values are: 'timeCreated', 'schemaName', 'objectName', 'columnName', 'dataType'
`opc_request_id`	(optional) Unique identifier for the request.
`is_case_in_sensitive`	(optional) A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENSITIVE_DATA_MODELS Function

Gets a list of sensitive data models based on the specified query parameters.

Syntax

FUNCTION list_sensitive_data_models (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sensitive_data_model_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sensitive_data_models_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`sensitive_data_model_id`	(optional) A filter to return only the resources that match the specified sensitive data model OCID.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENSITIVE_OBJECTS Function

Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.

Syntax

FUNCTION list_sensitive_objects (
  sensitive_data_model_id varchar2,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  object_type dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sensitive_objects_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`object_name`	(optional) A filter to return only items related to a specific object name.
`object_type`	(optional) A filter to return only items related to a specific object type. Allowed values are: 'ALL', 'TABLE', 'EDITIONING_VIEW'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. Allowed values are: 'schemaName', 'objectName', 'objectType'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENSITIVE_SCHEMAS Function

Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.

Syntax

FUNCTION list_sensitive_schemas (
  sensitive_data_model_id varchar2,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sensitive_schemas_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order is ascending. Allowed values are: 'schemaName'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SENSITIVE_TYPES Function

Gets a list of sensitive types based on the specified query parameters.

Syntax

FUNCTION list_sensitive_types (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sensitive_type_id varchar2 DEFAULT NULL,
  sensitive_type_source varchar2 DEFAULT NULL,
  entity_type varchar2 DEFAULT NULL,
  parent_category_id varchar2 DEFAULT NULL,
  default_masking_format_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  is_common number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sensitive_types_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`sensitive_type_id`	(optional) A filter to return only items related to a specific sensitive type OCID.
`sensitive_type_source`	(optional) A filter to return the sensitive type resources based on the value of their source attribute. Allowed values are: 'ORACLE', 'USER'
`entity_type`	(optional) A filter to return the sensitive type resources based on the value of their entityType attribute. Allowed values are: 'SENSITIVE_TYPE', 'SENSITIVE_CATEGORY'
`parent_category_id`	(optional) A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID.
`default_masking_format_id`	(optional) A filter to return only the sensitive types that have the default masking format identified by the specified OCID.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`is_common`	(optional) A filter to return only the common sensitive type resources. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_COLLECTION_ANALYTICS Function

Retrieves a list of all SQL collection analytics in Data Safe. The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_collection_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  time_started timestamp with time zone DEFAULT NULL,
  time_ended timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_collection_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the SQL collection. Allowed values are: 'CREATING', 'UPDATING', 'COLLECTING', 'COMPLETED', 'INACTIVE', 'FAILED', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`group_by`	(optional) The group by parameter to summarize SQL collection aggregation. Allowed values are: 'targetId', 'lifecycleState'
`time_started`	(optional) An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.
`time_ended`	(optional) An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_COLLECTION_LOG_INSIGHTS Function

Retrieves a list of the SQL collection log analytics.

Syntax

FUNCTION list_sql_collection_log_insights (
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  sql_collection_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  group_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_collection_log_insights_response_t;

Parameters

Parameter	Description
`time_started`	(required) An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.
`time_ended`	(required) An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`group_by`	(optional) The group by parameter to summarize SQL collection log insights aggregation. Allowed values are: 'clientIp', 'clientProgram', 'clientOsUserName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_COLLECTIONS Function

Retrieves a list of all SQL collections in Data Safe. The ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_collections (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sql_collection_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  db_user_name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_collections_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the SQL collection. Allowed values are: 'CREATING', 'UPDATING', 'COLLECTING', 'COMPLETED', 'INACTIVE', 'FAILED', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'
`sql_collection_id`	(optional) An optional filter to return only resources that match the specified OCID of the SQL collection resource.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`db_user_name`	(optional) A filter to return only items that match the specified user name.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME', 'TIMELASTSTARTED'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_ALLOWED_SQL_ANALYTICS Function

Returns the aggregation details of all SQL Firewall allowed SQL statements. The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallAllowedSqlAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_firewall_allowed_sql_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_allowed_sql_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(currentUser eq 'SCOTT') and (topLevel eq 'YES')
`group_by`	(optional) The group by parameter to summarize the allowed SQL aggregation. Allowed values are: 'dbUserName', 'sqlLevel', 'sqlFirewallPolicyId', 'lifecycleState'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_ALLOWED_SQLS Function

Retrieves a list of all SQL Firewall allowed SQL statements. The ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_firewall_allowed_sqls (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_allowed_sqls_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(currentUser eq 'SCOTT') and (topLevel eq 'YES')
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort parameter should be provided. Allowed values are: 'displayName', 'timeCollected'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_POLICIES Function

Retrieves a list of all SQL Firewall policies. The ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_firewall_policies (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  security_policy_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sql_firewall_policy_id varchar2 DEFAULT NULL,
  db_user_name varchar2 DEFAULT NULL,
  violation_action varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`security_policy_id`	(optional) An optional filter to return only resources that match the specified OCID of the security policy resource.
`lifecycle_state`	(optional) The current state of the SQL Firewall policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'FAILED', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'
`sql_firewall_policy_id`	(optional) An optional filter to return only resources that match the specified OCID of the SQL Firewall policy resource.
`db_user_name`	(optional) A filter to return only items that match the specified user name.
`violation_action`	(optional) An optional filter to return only resources that match the specified violation action. Allowed values are: 'block', 'observe'
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_POLICY_ANALYTICS Function

Gets a list of aggregated SQL Firewall policy details. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform SummarizedSqlFirewallPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_sql_firewall_policy_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  security_policy_id varchar2 DEFAULT NULL,
  time_started timestamp with time zone DEFAULT NULL,
  time_ended timestamp with time zone DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_policy_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`group_by`	(optional) The group by parameter to summarize SQL Firewall policy aggregation. Allowed values are: 'violationAction', 'enforcementScope', 'securityPolicyId', 'lifecycleState'
`lifecycle_state`	(optional) The current state of the SQL Firewall policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'FAILED', 'DELETING', 'DELETED', 'NEEDS_ATTENTION'
`security_policy_id`	(optional) An optional filter to return only resources that match the specified OCID of the security policy resource.
`time_started`	(optional) An optional filter to return the summary of the SQL Firewall policies created after the date-time specified, in the format defined by RFC3339.
`time_ended`	(optional) An optional filter to return the summary of the SQL Firewall policies created before the date-time specified, in the format defined by RFC3339.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_VIOLATION_ANALYTICS Function

Returns the aggregation details of the SQL Firewall violations.

Syntax

FUNCTION list_sql_firewall_violation_analytics (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  time_started timestamp with time zone DEFAULT NULL,
  time_ended timestamp with time zone DEFAULT NULL,
  query_time_zone varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  summary_field dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  group_by dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_violation_analytics_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`time_started`	(optional) An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.
`time_ended`	(optional) An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.
`query_time_zone`	(optional) Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) If this query parameter is specified, the result is sorted by this query parameter value. Allowed values are: 'dbUserName', 'targetId', 'targetName', 'operationTime', 'timeCollected', 'clientOsUserName', 'operation', 'currentDbUserName', 'sqlLevel', 'clientIp', 'clientProgram', 'violationCause', 'violationAction', 'violationCount'
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')
`summary_field`	(optional) Specifies a subset of summarized fields to be returned in the response. Allowed values are: 'dbUserName', 'targetName', 'clientOsUserName', 'operation', 'sqlText', 'currentDbUserName', 'sqlLevel', 'clientIp', 'clientProgram', 'violationCause', 'violationAction', 'selects', 'creates', 'alters', 'drops', 'grants', 'revokes'
`group_by`	(optional) A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. Allowed values are: 'dbUserName', 'targetName', 'operationTime', 'timeCollected', 'clientOsUserName', 'operation', 'sqlText', 'currentDbUserName', 'sqlLevel', 'clientIp', 'clientProgram', 'violationCause', 'violationAction'
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_FIREWALL_VIOLATIONS Function

Gets a list of all the SQL Firewall violations captured by the firewall.

Syntax

FUNCTION list_sql_firewall_violations (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  scim_query varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_sql_firewall_violations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique identifier for the request.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) If this query parameter is specified, the result is sorted by this query parameter value. Allowed values are: 'dbUserName', 'targetId', 'targetName', 'operationTime', 'timeCollected', 'clientOsUserName', 'operation', 'currentDbUserName', 'sqlLevel', 'clientIp', 'clientProgram', 'violationCause', 'violationAction'
`scim_query`	(optional) The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: query=(operationTime ge '2021-06-04T01-00-26') and (violationAction eq 'BLOCKED')
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TABLES Function

Returns a list of table metadata objects.

Syntax

FUNCTION list_tables (
  target_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  schema_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  table_name dbms_cloud_oci_datasafe_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  table_name_contains varchar2 DEFAULT NULL,
  schema_name_contains varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_tables_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`schema_name`	(optional) A filter to return only items related to specific schema name.
`table_name`	(optional) A filter to return only items related to specific table name.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. Allowed values are: 'SCHEMANAME', 'TABLENAME'
`table_name_contains`	(optional) A filter to return only items if table name contains a specific string.
`schema_name_contains`	(optional) A filter to return only items if schema name contains a specific string.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TARGET_ALERT_POLICY_ASSOCIATIONS Function

Gets a list of all target-alert policy associations.

Syntax

FUNCTION list_target_alert_policy_associations (
  compartment_id varchar2,
  target_alert_policy_association_id varchar2 DEFAULT NULL,
  alert_policy_id varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_target_alert_policy_associations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`target_alert_policy_association_id`	(optional) A filter to return only items related to a specific target-alert policy association ID.
`alert_policy_id`	(optional) A filter to return policy by it's OCID.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`lifecycle_state`	(optional) An optional filter to return only alert policies that have the given life-cycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort parameter may be provided. Allowed values are: 'DISPLAYNAME', 'TIMECREATED', 'TIMEUPDATED'
`opc_request_id`	(optional) Unique identifier for the request.
`time_created_greater_than_or_equal_to`	(optional) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TARGET_DATABASES Function

Returns the list of registered target databases in Data Safe.

Syntax

FUNCTION list_target_databases (
  compartment_id varchar2,
  associated_resource_id varchar2 DEFAULT NULL,
  target_database_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  database_type varchar2 DEFAULT NULL,
  infrastructure_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_target_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`associated_resource_id`	(optional) A filter to return the target databases that are associated to the resource id passed in as a parameter value.
`target_database_id`	(optional) A filter to return the target database that matches the specified OCID.
`display_name`	(optional) A filter to return only resources that match the specified display name.
`lifecycle_state`	(optional) A filter to return only target databases that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'NEEDS_ATTENTION', 'FAILED'
`database_type`	(optional) A filter to return only target databases that match the specified database type. Allowed values are: 'DATABASE_CLOUD_SERVICE', 'AUTONOMOUS_DATABASE', 'INSTALLED_DATABASE'
`infrastructure_type`	(optional) A filter to return only target databases that match the specified infrastructure type. Allowed values are: 'ORACLE_CLOUD', 'CLOUD_AT_CUSTOMER', 'ON_PREMISES', 'NON_ORACLE_CLOUD'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_USER_ANALYTICS Function

Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics. When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned. The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Syntax

FUNCTION list_user_analytics (
  user_assessment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  user_category varchar2 DEFAULT NULL,
  user_key varchar2 DEFAULT NULL,
  account_status varchar2 DEFAULT NULL,
  authentication_type varchar2 DEFAULT NULL,
  user_name varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  time_last_login_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_last_login_less_than timestamp with time zone DEFAULT NULL,
  time_user_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_user_created_less_than timestamp with time zone DEFAULT NULL,
  time_password_last_changed_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_password_last_changed_less_than timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_user_analytics_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`user_category`	(optional) A filter to return only items that match the specified user category.
`user_key`	(optional) A filter to return only items that match the specified user key.
`account_status`	(optional) A filter to return only items that match the specified account status.
`authentication_type`	(optional) A filter to return only items that match the specified authentication type.
`user_name`	(optional) A filter to return only items that match the specified user name.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`time_last_login_greater_than_or_equal_to`	(optional) A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_last_login_less_than`	(optional) A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_user_created_greater_than_or_equal_to`	(optional) A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_user_created_less_than`	(optional) A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_password_last_changed_greater_than_or_equal_to`	(optional) A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_password_last_changed_less_than`	(optional) A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. Allowed values are: 'userName', 'userCategory', 'accountStatus', 'timeLastLogin', 'targetId', 'timeUserCreated', 'authenticationType', 'timePasswordChanged'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_USER_ASSESSMENTS Function

Gets a list of user assessments. The ListUserAssessments operation returns only the assessments in the specified `compartmentId`. The list does not include any subcompartments of the compartmentId passed. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. The parameter `compartmentIdInSubtree` applies when you perform ListUserAssessments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

Syntax

FUNCTION list_user_assessments (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  schedule_user_assessment_id varchar2 DEFAULT NULL,
  is_schedule_assessment number DEFAULT NULL,
  is_baseline number DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  triggered_by varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_user_assessments_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`display_name`	(optional) A filter to return only resources that match the specified display name.
`schedule_user_assessment_id`	(optional) The OCID of the user assessment of type SAVE_SCHEDULE.
`is_schedule_assessment`	(optional) A filter to return only user assessments of type SAVE_SCHEDULE.
`is_baseline`	(optional) A filter to return only user assessments that are set as baseline.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`l_type`	(optional) A filter to return only items that match the specified assessment type. Allowed values are: 'LATEST', 'SAVED', 'COMPARTMENT', 'SAVE_SCHEDULE'
`triggered_by`	(optional) A filter to return user assessments that were created by either the system or by a user only. Allowed values are: 'USER', 'SYSTEM'
`time_created_greater_than_or_equal_to`	(optional) A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date. Example: 2016-12-19T16:39:57.600Z
`time_created_less_than`	(optional) Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339. Example: 2016-12-19T16:39:57.600Z
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) The current state of the user assessment. Allowed values are: 'CREATING', 'SUCCEEDED', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_USERS Function

Gets a list of users of the specified user assessment. The result contains the database user details for each user, such as user type, account status, last login time, user creation time, authentication type, user profile, and the date and time of the latest password change. It also contains the user category derived from these user details as well as privileges granted to each user.

Syntax

FUNCTION list_users (
  user_assessment_id varchar2,
  limit number DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  user_category varchar2 DEFAULT NULL,
  user_role varchar2 DEFAULT NULL,
  user_profile varchar2 DEFAULT NULL,
  user_type varchar2 DEFAULT NULL,
  user_key varchar2 DEFAULT NULL,
  account_status varchar2 DEFAULT NULL,
  authentication_type varchar2 DEFAULT NULL,
  user_name varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  time_last_login_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_last_login_less_than timestamp with time zone DEFAULT NULL,
  time_user_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_user_created_less_than timestamp with time zone DEFAULT NULL,
  time_password_last_changed_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_password_last_changed_less_than timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_users_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`user_category`	(optional) A filter to return only items that match the specified user category.
`user_role`	(optional) A filter to return only items that match the specified user role.
`user_profile`	(optional) A filter to return only items that match the specified user profile.
`user_type`	(optional) A filter to return only items that match the specified user type. The possible values can be - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED as specified by '#/definitions/userTypes'.
`user_key`	(optional) A filter to return only items that match the specified user key.
`account_status`	(optional) A filter to return only items that match the specified account status.
`authentication_type`	(optional) A filter to return only items that match the specified authentication type.
`user_name`	(optional) A filter to return only items that match the specified user name.
`target_id`	(optional) A filter to return only items related to a specific target OCID.
`time_last_login_greater_than_or_equal_to`	(optional) A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_last_login_less_than`	(optional) A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_user_created_greater_than_or_equal_to`	(optional) A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_user_created_less_than`	(optional) A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_password_last_changed_greater_than_or_equal_to`	(optional) A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`time_password_last_changed_less_than`	(optional) A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. Allowed values are: 'userName', 'userCategory', 'accountStatus', 'timeLastLogin', 'targetId', 'timeUserCreated', 'authenticationType', 'timePasswordChanged'
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Gets a list of errors for the specified work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Gets a list of log entries for the specified work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Gets a list of work requests.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  operation_type varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  target_database_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that match the specified compartment OCID.
`operation_type`	(optional) A filter to return only work requests that match the specific operation type.
`sort_by`	(optional) The field used for sorting. Only one sorting parameter can be specified. The default order is descending. Allowed values are: 'STARTTIME', 'FINISHTIME', 'ACCEPTEDTIME'
`sort_order`	(optional) The sorting order for the work requests, either ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC'
`resource_id`	(optional) A filter to return only work requests that match the specified resource OCID.
`target_database_id`	(optional) A filter to return only work requests that are associated to the specified target database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous \"List\" call. For details about how pagination works, see List Pagination.
`limit`	(optional) For list pagination. The maximum number of items to return per page in a paginated \"List\" call. For details about how pagination works, see List Pagination.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

MASK_DATA Function

Masks data using the specified masking policy.

Syntax

FUNCTION mask_data (
  masking_policy_id varchar2,
  mask_data_details dbms_cloud_oci_datasafe_mask_data_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_mask_data_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`mask_data_details`	(required) Details to mask data.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

MODIFY_GLOBAL_SETTINGS Function

Modifies Global Settings in Data Safe in the tenancy and region.

Syntax

FUNCTION modify_global_settings (
  modify_global_settings_details dbms_cloud_oci_datasafe_modify_global_settings_details_t,
  compartment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_modify_global_settings_response_t;

Parameters

Parameter	Description
`modify_global_settings_details`	(required) The details used to update global settings in Data Safe.
`compartment_id`	(required) The OCID of the compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_ALERTS Function

Updates the status of one or more alert specified by the alert IDs.

Syntax

FUNCTION patch_alerts (
  patch_alerts_details dbms_cloud_oci_datasafe_patch_alerts_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_alerts_response_t;

Parameters

Parameter	Description
`patch_alerts_details`	(required) The alert details to update the status of one or more alert specified by the alert IDs.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`compartment_id_in_subtree`	(optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
`access_level`	(optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. Allowed values are: 'RESTRICTED', 'ACCESSIBLE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_DISCOVERY_JOB_RESULTS Function

Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using ApplyDiscoveryJobResults to process the results based on this attribute.

Syntax

FUNCTION patch_discovery_job_results (
  discovery_job_id varchar2,
  patch_discovery_job_result_details dbms_cloud_oci_datasafe_patch_discovery_job_result_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_discovery_job_results_response_t;

Parameters

Parameter	Description
`discovery_job_id`	(required) The OCID of the discovery job.
`patch_discovery_job_result_details`	(required) Details to patch discovery results.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_MASKING_COLUMNS Function

Patches one or more columns in the specified masking policy. Use it to create, or update masking columns. To create masking columns, use CreateMaskingColumnDetails as the patch value. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.

Syntax

FUNCTION patch_masking_columns (
  masking_policy_id varchar2,
  patch_masking_columns_details dbms_cloud_oci_datasafe_patch_masking_columns_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_masking_columns_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`patch_masking_columns_details`	(required) Details to patch masking columns.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_SDM_MASKING_POLICY_DIFFERENCE_COLUMNS Function

Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using ApplySdmMaskingPolicyDifference to process the difference based on this attribute.

Syntax

FUNCTION patch_sdm_masking_policy_difference_columns (
  sdm_masking_policy_difference_id varchar2,
  patch_sdm_masking_policy_difference_columns_details dbms_cloud_oci_datasafe_patch_sdm_masking_policy_difference_columns_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_sdm_masking_policy_difference_columns_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`patch_sdm_masking_policy_difference_columns_details`	(required) Details to patch difference columns.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_SENSITIVE_COLUMNS Function

Patches one or more columns in the specified sensitive data model. Use it to create, update, or delete sensitive columns. To create sensitive columns, use CreateSensitiveColumnDetails as the patch value. And to update sensitive columns, use UpdateSensitiveColumnDetails as the patch value.

Syntax

FUNCTION patch_sensitive_columns (
  sensitive_data_model_id varchar2,
  patch_sensitive_column_details dbms_cloud_oci_datasafe_patch_sensitive_column_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_sensitive_columns_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`patch_sensitive_column_details`	(required) Details to patch sensitive columns.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_TARGET_ALERT_POLICY_ASSOCIATION Function

Creates new target-alert policy associations that will be applied on the target database.

Syntax

FUNCTION patch_target_alert_policy_association (
  patch_target_alert_policy_association_details dbms_cloud_oci_datasafe_patch_target_alert_policy_association_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_patch_target_alert_policy_association_response_t;

Parameters

Parameter	Description
`patch_target_alert_policy_association_details`	(required) The details used to patch the target-alert policy associations.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PROVISION_AUDIT_POLICY Function

Provision audit policy.

Syntax

FUNCTION provision_audit_policy (
  provision_audit_policy_details dbms_cloud_oci_datasafe_provision_audit_policy_details_t,
  audit_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_provision_audit_policy_response_t;

Parameters

Parameter	Description
`provision_audit_policy_details`	(required) Details for provisioning the given policies on the source target database.
`audit_policy_id`	(required) Unique audit policy identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PURGE_SQL_COLLECTION_LOGS Function

Purge the SQL collection logs for the specified SqlCollection.

Syntax

FUNCTION purge_sql_collection_logs (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_purge_sql_collection_logs_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_DATABASE_SECURITY_CONFIGURATION Function

Refreshes the specified database security configuration.

Syntax

FUNCTION refresh_database_security_configuration (
  database_security_config_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_refresh_database_security_configuration_response_t;

Parameters

Parameter	Description
`database_security_config_id`	(required) The OCID of the database security configuration resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_SECURITY_ASSESSMENT Function

Runs a security assessment, refreshes the latest assessment, and saves it for future reference. The assessment runs with a securityAssessmentId of type LATEST. Before you start, first call the ListSecurityAssessments operation with filter \"type = latest\" to get the security assessment id for the target's latest assessment.

Syntax

FUNCTION refresh_security_assessment (
  security_assessment_id varchar2,
  run_security_assessment_details dbms_cloud_oci_datasafe_run_security_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_refresh_security_assessment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`run_security_assessment_details`	(required) Details to create an on-demand saved security assessment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_SQL_COLLECTION_LOG_INSIGHTS Function

Refresh the specified SQL collection Log Insights.

Syntax

FUNCTION refresh_sql_collection_log_insights (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_refresh_sql_collection_log_insights_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_USER_ASSESSMENT Function

Refreshes the latest assessment and saves it for future reference. This operation runs with a userAssessmentId of type LATEST. Before you start, first call the ListUserAssessments operation with filter \"type = latest\" to get the user assessment ID for the target's latest assessment.

Syntax

FUNCTION refresh_user_assessment (
  user_assessment_id varchar2,
  run_user_assessment_details dbms_cloud_oci_datasafe_run_user_assessment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_refresh_user_assessment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`run_user_assessment_details`	(required) The details required to create an on-demand saved user assessment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_SCHEDULE_REPORT Function

Deletes the schedule of a .xls or .pdf report.

Syntax

FUNCTION remove_schedule_report (
  report_definition_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_remove_schedule_report_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESUME_AUDIT_TRAIL Function

Resumes the specified audit trail once it got stopped.

Syntax

FUNCTION resume_audit_trail (
  audit_trail_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_resume_audit_trail_response_t;

Parameters

Parameter	Description
`audit_trail_id`	(required) The OCID of the audit trail.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESUME_WORK_REQUEST Function

Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.

Syntax

FUNCTION resume_work_request (
  work_request_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_resume_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RETRIEVE_AUDIT_POLICIES Function

Retrieves the audit policy details from the source target database.

Syntax

FUNCTION retrieve_audit_policies (
  audit_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_retrieve_audit_policies_response_t;

Parameters

Parameter	Description
`audit_policy_id`	(required) Unique audit policy identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SCHEDULE_REPORT Function

Schedules a .xls or .pdf report based on parameters and report definition.

Syntax

FUNCTION schedule_report (
  report_definition_id varchar2,
  schedule_report_details dbms_cloud_oci_datasafe_schedule_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_schedule_report_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`schedule_report_details`	(required) The details for the audit report schedule. It contains details such as schedule, MIME type .xls/.pdf and number of rows.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SET_SECURITY_ASSESSMENT_BASELINE Function

Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. The security assessment needs to be of type 'SAVED'.

Syntax

FUNCTION set_security_assessment_baseline (
  security_assessment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  base_line_details dbms_cloud_oci_datasafe_security_assessment_base_line_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_set_security_assessment_baseline_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`base_line_details`	(optional) Details of security assessment that need to be updated while setting the baseline.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SET_USER_ASSESSMENT_BASELINE Function

Sets the saved user assessment as the baseline in the compartment where the specified assessment resides. The user assessment needs to be of type 'SAVED'.

Syntax

FUNCTION set_user_assessment_baseline (
  user_assessment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  base_line_details dbms_cloud_oci_datasafe_user_assessment_base_line_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_set_user_assessment_baseline_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`base_line_details`	(optional) Details of user assessment that need to be updated while setting the baseline.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_AUDIT_TRAIL Function

Starts collection of audit records on the specified audit trail.

Syntax

FUNCTION start_audit_trail (
  start_audit_trail_details dbms_cloud_oci_datasafe_start_audit_trail_details_t,
  audit_trail_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_start_audit_trail_response_t;

Parameters

Parameter	Description
`start_audit_trail_details`	(required) Details for the starting audit.
`audit_trail_id`	(required) The OCID of the audit trail.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_SQL_COLLECTION Function

Start the specified SQL collection.

Syntax

FUNCTION start_sql_collection (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_start_sql_collection_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_AUDIT_TRAIL Function

Stops the specified audit trail.

Syntax

FUNCTION stop_audit_trail (
  audit_trail_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_stop_audit_trail_response_t;

Parameters

Parameter	Description
`audit_trail_id`	(required) The OCID of the audit trail.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_SQL_COLLECTION Function

Stops the specified SQL collection.

Syntax

FUNCTION stop_sql_collection (
  sql_collection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_stop_sql_collection_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUSPEND_WORK_REQUEST Function

Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.

Syntax

FUNCTION suspend_work_request (
  work_request_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_suspend_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UNSET_SECURITY_ASSESSMENT_BASELINE Function

Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Syntax

FUNCTION unset_security_assessment_baseline (
  security_assessment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_unset_security_assessment_baseline_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UNSET_USER_ASSESSMENT_BASELINE Function

Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Syntax

FUNCTION unset_user_assessment_baseline (
  user_assessment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_unset_user_assessment_baseline_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ALERT Function

Updates the status of the specified alert.

Syntax

FUNCTION update_alert (
  alert_id varchar2,
  update_alert_details dbms_cloud_oci_datasafe_update_alert_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_alert_response_t;

Parameters

Parameter	Description
`alert_id`	(required) The OCID of alert.
`update_alert_details`	(required) The details used to update alert status.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUDIT_ARCHIVE_RETRIEVAL Function

Updates the audit archive retrieval.

Syntax

FUNCTION update_audit_archive_retrieval (
  audit_archive_retrieval_id varchar2,
  update_audit_archive_retrieval_details dbms_cloud_oci_datasafe_update_audit_archive_retrieval_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_audit_archive_retrieval_response_t;

Parameters

Parameter	Description
`audit_archive_retrieval_id`	(required) OCID of the archive retrieval.
`update_audit_archive_retrieval_details`	(required) Details to update the audit archive retrieval.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUDIT_POLICY Function

Updates the audit policy.

Syntax

FUNCTION update_audit_policy (
  audit_policy_id varchar2,
  update_audit_policy_details dbms_cloud_oci_datasafe_update_audit_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_audit_policy_response_t;

Parameters

Parameter	Description
`audit_policy_id`	(required) Unique audit policy identifier.
`update_audit_policy_details`	(required) Details to update the audit policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUDIT_PROFILE Function

Updates one or more attributes of the specified audit profile.

Syntax

FUNCTION update_audit_profile (
  audit_profile_id varchar2,
  update_audit_profile_details dbms_cloud_oci_datasafe_update_audit_profile_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_audit_profile_response_t;

Parameters

Parameter	Description
`audit_profile_id`	(required) The OCID of the audit.
`update_audit_profile_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUDIT_TRAIL Function

Updates one or more attributes of the specified audit trail.

Syntax

FUNCTION update_audit_trail (
  audit_trail_id varchar2,
  update_audit_trail_details dbms_cloud_oci_datasafe_update_audit_trail_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_audit_trail_response_t;

Parameters

Parameter	Description
`audit_trail_id`	(required) The OCID of the audit trail.
`update_audit_trail_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATA_SAFE_PRIVATE_ENDPOINT Function

Updates one or more attributes of the specified Data Safe private endpoint.

Syntax

FUNCTION update_data_safe_private_endpoint (
  data_safe_private_endpoint_id varchar2,
  update_data_safe_private_endpoint_details dbms_cloud_oci_datasafe_update_data_safe_private_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_data_safe_private_endpoint_response_t;

Parameters

Parameter	Description
`data_safe_private_endpoint_id`	(required) The OCID of the private endpoint.
`update_data_safe_private_endpoint_details`	(required) The details used to update a Data Safe private endpoint.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATABASE_SECURITY_CONFIG Function

Updates the database security configuration.

Syntax

FUNCTION update_database_security_config (
  database_security_config_id varchar2,
  update_database_security_config_details dbms_cloud_oci_datasafe_update_database_security_config_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_database_security_config_response_t;

Parameters

Parameter	Description
`database_security_config_id`	(required) The OCID of the database security configuration resource.
`update_database_security_config_details`	(required) Details to update the database security configuration.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_LIBRARY_MASKING_FORMAT Function

Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries.

Syntax

FUNCTION update_library_masking_format (
  library_masking_format_id varchar2,
  update_library_masking_format_details dbms_cloud_oci_datasafe_update_library_masking_format_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_library_masking_format_response_t;

Parameters

Parameter	Description
`library_masking_format_id`	(required) The OCID of the library masking format.
`update_library_masking_format_details`	(required) Details to update a library masking format.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MASKING_COLUMN Function

Updates one or more attributes of the specified masking column. Note that updating the maskingFormats attribute replaces the currently assigned masking formats with the specified masking formats.

Syntax

FUNCTION update_masking_column (
  masking_column_key varchar2,
  masking_policy_id varchar2,
  update_masking_column_details dbms_cloud_oci_datasafe_update_masking_column_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_masking_column_response_t;

Parameters

Parameter	Description
`masking_column_key`	(required) The unique key that identifies the masking column. It's numeric and unique within a masking policy.
`masking_policy_id`	(required) The OCID of the masking policy.
`update_masking_column_details`	(required) Details to update a masking column.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MASKING_POLICY Function

Updates one or more attributes of the specified masking policy.

Syntax

FUNCTION update_masking_policy (
  masking_policy_id varchar2,
  update_masking_policy_details dbms_cloud_oci_datasafe_update_masking_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_masking_policy_response_t;

Parameters

Parameter	Description
`masking_policy_id`	(required) The OCID of the masking policy.
`update_masking_policy_details`	(required) Details to update a masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ON_PREM_CONNECTOR Function

Updates one or more attributes of the specified on-premises connector.

Syntax

FUNCTION update_on_prem_connector (
  on_prem_connector_id varchar2,
  update_on_prem_connector_details dbms_cloud_oci_datasafe_update_on_prem_connector_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_on_prem_connector_response_t;

Parameters

Parameter	Description
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`update_on_prem_connector_details`	(required) The details used to update a on-premises connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ON_PREM_CONNECTOR_WALLET Function

Updates the wallet for the specified on-premises connector to a new version.

Syntax

FUNCTION update_on_prem_connector_wallet (
  update_on_prem_connector_wallet_details dbms_cloud_oci_datasafe_update_on_prem_connector_wallet_details_t,
  on_prem_connector_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_on_prem_connector_wallet_response_t;

Parameters

Parameter	Description
`update_on_prem_connector_wallet_details`	(required) The details used to update an on-premises connector's wallet.
`on_prem_connector_id`	(required) The OCID of the on-premises connector.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REPORT_DEFINITION Function

Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first.

Syntax

FUNCTION update_report_definition (
  report_definition_id varchar2,
  update_report_definition_details dbms_cloud_oci_datasafe_update_report_definition_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_report_definition_response_t;

Parameters

Parameter	Description
`report_definition_id`	(required) Unique report definition identifier
`update_report_definition_details`	(required) Details for the modified report definition.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SDM_MASKING_POLICY_DIFFERENCE Function

Updates one or more attributes of the specified sdm masking policy difference.

Syntax

FUNCTION update_sdm_masking_policy_difference (
  sdm_masking_policy_difference_id varchar2,
  update_sdm_masking_policy_difference_details dbms_cloud_oci_datasafe_update_sdm_masking_policy_difference_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sdm_masking_policy_difference_response_t;

Parameters

Parameter	Description
`sdm_masking_policy_difference_id`	(required) The OCID of the SDM masking policy difference.
`update_sdm_masking_policy_difference_details`	(required) Details to update a sdm masking policy difference.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SECURITY_ASSESSMENT Function

Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.

Syntax

FUNCTION update_security_assessment (
  security_assessment_id varchar2,
  update_security_assessment_details dbms_cloud_oci_datasafe_update_security_assessment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_security_assessment_response_t;

Parameters

Parameter	Description
`security_assessment_id`	(required) The OCID of the security assessment.
`update_security_assessment_details`	(required) The information to be updated.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SECURITY_POLICY Function

Updates the security policy.

Syntax

FUNCTION update_security_policy (
  security_policy_id varchar2,
  update_security_policy_details dbms_cloud_oci_datasafe_update_security_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_security_policy_response_t;

Parameters

Parameter	Description
`security_policy_id`	(required) The OCID of the security policy resource.
`update_security_policy_details`	(required) Details to update the security policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SECURITY_POLICY_DEPLOYMENT Function

Updates the security policy deployment.

Syntax

FUNCTION update_security_policy_deployment (
  security_policy_deployment_id varchar2,
  update_security_policy_deployment_details dbms_cloud_oci_datasafe_update_security_policy_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_security_policy_deployment_response_t;

Parameters

Parameter	Description
`security_policy_deployment_id`	(required) The OCID of the security policy deployment resource.
`update_security_policy_deployment_details`	(required) Details to update the security policy deployment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SENSITIVE_COLUMN Function

Updates one or more attributes of the specified sensitive column.

Syntax

FUNCTION update_sensitive_column (
  sensitive_data_model_id varchar2,
  sensitive_column_key varchar2,
  update_sensitive_column_details dbms_cloud_oci_datasafe_update_sensitive_column_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sensitive_column_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`sensitive_column_key`	(required) The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
`update_sensitive_column_details`	(required) Details to update a sensitive column.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SENSITIVE_DATA_MODEL Function

Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.

Syntax

FUNCTION update_sensitive_data_model (
  sensitive_data_model_id varchar2,
  update_sensitive_data_model_details dbms_cloud_oci_datasafe_update_sensitive_data_model_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sensitive_data_model_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`update_sensitive_data_model_details`	(required) Details to update a sensitive data model.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SENSITIVE_TYPE Function

Updates one or more attributes of the specified sensitive type.

Syntax

FUNCTION update_sensitive_type (
  sensitive_type_id varchar2,
  update_sensitive_type_details dbms_cloud_oci_datasafe_update_sensitive_type_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sensitive_type_response_t;

Parameters

Parameter	Description
`sensitive_type_id`	(required) The OCID of the sensitive type.
`update_sensitive_type_details`	(required) Details to update a sensitive type.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SQL_COLLECTION Function

Updates the SQL collection.

Syntax

FUNCTION update_sql_collection (
  sql_collection_id varchar2,
  update_sql_collection_details dbms_cloud_oci_datasafe_update_sql_collection_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sql_collection_response_t;

Parameters

Parameter	Description
`sql_collection_id`	(required) The OCID of the SQL collection resource.
`update_sql_collection_details`	(required) Details to update the SQL collection.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SQL_FIREWALL_POLICY Function

Updates the SQL Firewall policy.

Syntax

FUNCTION update_sql_firewall_policy (
  sql_firewall_policy_id varchar2,
  update_sql_firewall_policy_details dbms_cloud_oci_datasafe_update_sql_firewall_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_sql_firewall_policy_response_t;

Parameters

Parameter	Description
`sql_firewall_policy_id`	(required) The OCID of the SQL Firewall policy resource.
`update_sql_firewall_policy_details`	(required) Details to update the SQL Firewall policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TARGET_ALERT_POLICY_ASSOCIATION Function

Updates the specified target-alert policy association.

Syntax

FUNCTION update_target_alert_policy_association (
  target_alert_policy_association_id varchar2,
  update_target_alert_policy_association_details dbms_cloud_oci_datasafe_update_target_alert_policy_association_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_target_alert_policy_association_response_t;

Parameters

Parameter	Description
`target_alert_policy_association_id`	(required) The OCID of the target-alert policy association.
`update_target_alert_policy_association_details`	(required) The details used to update the target-alert policy association.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TARGET_DATABASE Function

Updates one or more attributes of the specified Data Safe target database.

Syntax

FUNCTION update_target_database (
  target_database_id varchar2,
  update_target_database_details dbms_cloud_oci_datasafe_update_target_database_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_target_database_response_t;

Parameters

Parameter	Description
`target_database_id`	(required) The OCID of the Data Safe target database.
`update_target_database_details`	(required) Details used to update the target database in Data Safe.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_USER_ASSESSMENT Function

Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.

Syntax

FUNCTION update_user_assessment (
  user_assessment_id varchar2,
  update_user_assessment_details dbms_cloud_oci_datasafe_update_user_assessment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_update_user_assessment_response_t;

Parameters

Parameter	Description
`user_assessment_id`	(required) The OCID of the user assessment.
`update_user_assessment_details`	(required) The information to be updated.
`opc_request_id`	(optional) Unique identifier for the request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPLOAD_MASKING_POLICY Function

Uploads a masking policy file (also called template) to update the specified masking policy. To create a new masking policy using a file, first use the CreateMaskingPolicy operation to create an empty masking policy and then use this endpoint to upload the masking policy file. Note that the upload operation replaces the content of the specified masking policy, including all the existing columns and masking formats, with the content of the file.

Syntax

FUNCTION upload_masking_policy (
  upload_masking_policy_details blob,
  masking_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_upload_masking_policy_response_t;

Parameters

Parameter	Description
`upload_masking_policy_details`	(required) Details to upload a masking policy file.
`masking_policy_id`	(required) The OCID of the masking policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPLOAD_SENSITIVE_DATA_MODEL Function

Uploads a sensitive data model file (also called template) to update the specified sensitive data model. To create a new sensitive data model using a file, first use the CreateSensitiveDataModel operation to create an empty data model and then use this endpoint to upload the data model file. Note that the upload operation replaces the content of the specified sensitive data model, including all the existing columns and their relationships, with the content of the file.

Syntax

FUNCTION upload_sensitive_data_model (
  sensitive_data_model_id varchar2,
  upload_sensitive_data_model_details blob,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ds_data_safe_upload_sensitive_data_model_response_t;

Parameters

Parameter	Description
`sensitive_data_model_id`	(required) The OCID of the sensitive data model.
`upload_sensitive_data_model_details`	(required) Details to upload a sensitive data model file.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://datasafe.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ACTIVATE_TARGET_DATABASE Function 🔗

ADD_MASKING_COLUMNS_FROM_SDM Function 🔗

ALERTS_UPDATE Function 🔗

APPLY_DISCOVERY_JOB_RESULTS Function 🔗

APPLY_SDM_MASKING_POLICY_DIFFERENCE Function 🔗

CALCULATE_AUDIT_VOLUME_AVAILABLE Function 🔗

CALCULATE_AUDIT_VOLUME_COLLECTED Function 🔗

CANCEL_WORK_REQUEST Function 🔗

CHANGE_ALERT_COMPARTMENT Function 🔗

CHANGE_AUDIT_ARCHIVE_RETRIEVAL_COMPARTMENT Function 🔗

CHANGE_AUDIT_POLICY_COMPARTMENT Function 🔗

CHANGE_AUDIT_PROFILE_COMPARTMENT Function 🔗

CHANGE_DATA_SAFE_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_DATABASE_SECURITY_CONFIG_COMPARTMENT Function 🔗

CHANGE_DISCOVERY_JOB_COMPARTMENT Function 🔗

CHANGE_LIBRARY_MASKING_FORMAT_COMPARTMENT Function 🔗

CHANGE_MASKING_POLICY_COMPARTMENT Function 🔗

CHANGE_ON_PREM_CONNECTOR_COMPARTMENT Function 🔗

CHANGE_REPORT_COMPARTMENT Function 🔗

CHANGE_REPORT_DEFINITION_COMPARTMENT Function 🔗

CHANGE_RETENTION Function 🔗

CHANGE_SDM_MASKING_POLICY_DIFFERENCE_COMPARTMENT Function 🔗

CHANGE_SECURITY_ASSESSMENT_COMPARTMENT Function 🔗

CHANGE_SECURITY_POLICY_COMPARTMENT Function 🔗

CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT Function 🔗

CHANGE_SENSITIVE_DATA_MODEL_COMPARTMENT Function 🔗

CHANGE_SENSITIVE_TYPE_COMPARTMENT Function 🔗

CHANGE_SQL_COLLECTION_COMPARTMENT Function 🔗

CHANGE_SQL_FIREWALL_POLICY_COMPARTMENT Function 🔗

CHANGE_TARGET_ALERT_POLICY_ASSOCIATION_COMPARTMENT Function 🔗

CHANGE_TARGET_DATABASE_COMPARTMENT Function 🔗

CHANGE_USER_ASSESSMENT_COMPARTMENT Function 🔗

COMPARE_SECURITY_ASSESSMENT Function 🔗

COMPARE_USER_ASSESSMENT Function 🔗

CREATE_AUDIT_ARCHIVE_RETRIEVAL Function 🔗

CREATE_DATA_SAFE_PRIVATE_ENDPOINT Function 🔗

CREATE_DISCOVERY_JOB Function 🔗

CREATE_LIBRARY_MASKING_FORMAT Function 🔗

CREATE_MASKING_COLUMN Function 🔗

CREATE_MASKING_POLICY Function 🔗

CREATE_ON_PREM_CONNECTOR Function 🔗

CREATE_REPORT_DEFINITION Function 🔗

CREATE_SDM_MASKING_POLICY_DIFFERENCE Function 🔗

CREATE_SECURITY_ASSESSMENT Function 🔗

CREATE_SENSITIVE_COLUMN Function 🔗

CREATE_SENSITIVE_DATA_MODEL Function 🔗

CREATE_SENSITIVE_TYPE Function 🔗

CREATE_SQL_COLLECTION Function 🔗

CREATE_TARGET_ALERT_POLICY_ASSOCIATION Function 🔗

CREATE_TARGET_DATABASE Function 🔗

CREATE_USER_ASSESSMENT Function 🔗

DEACTIVATE_TARGET_DATABASE Function 🔗

DELETE_AUDIT_ARCHIVE_RETRIEVAL Function 🔗

DELETE_AUDIT_TRAIL Function 🔗

DELETE_DATA_SAFE_PRIVATE_ENDPOINT Function 🔗

DELETE_DISCOVERY_JOB Function 🔗

DELETE_DISCOVERY_JOB_RESULT Function 🔗

DELETE_LIBRARY_MASKING_FORMAT Function 🔗

DELETE_MASKING_COLUMN Function 🔗

DELETE_MASKING_POLICY Function 🔗

DELETE_ON_PREM_CONNECTOR Function 🔗

DELETE_REPORT_DEFINITION Function 🔗

DELETE_SDM_MASKING_POLICY_DIFFERENCE Function 🔗

DELETE_SECURITY_ASSESSMENT Function 🔗

DELETE_SENSITIVE_COLUMN Function 🔗

DELETE_SENSITIVE_DATA_MODEL Function 🔗

DELETE_SENSITIVE_TYPE Function 🔗

DELETE_SQL_COLLECTION Function 🔗

DELETE_SQL_FIREWALL_POLICY Function 🔗

DELETE_TARGET_ALERT_POLICY_ASSOCIATION Function 🔗

DELETE_TARGET_DATABASE Function 🔗

DELETE_USER_ASSESSMENT Function 🔗

DISCOVER_AUDIT_TRAILS Function 🔗

DOWNLOAD_DISCOVERY_REPORT Function 🔗

DOWNLOAD_MASKING_LOG Function 🔗

DOWNLOAD_MASKING_POLICY Function 🔗

DOWNLOAD_MASKING_REPORT Function 🔗

DOWNLOAD_PRIVILEGE_SCRIPT Function 🔗

DOWNLOAD_SECURITY_ASSESSMENT_REPORT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ACTIVATE_TARGET_DATABASE Function

ADD_MASKING_COLUMNS_FROM_SDM Function

ALERTS_UPDATE Function

APPLY_DISCOVERY_JOB_RESULTS Function

APPLY_SDM_MASKING_POLICY_DIFFERENCE Function

CALCULATE_AUDIT_VOLUME_AVAILABLE Function

CALCULATE_AUDIT_VOLUME_COLLECTED Function

CANCEL_WORK_REQUEST Function

CHANGE_ALERT_COMPARTMENT Function

CHANGE_AUDIT_ARCHIVE_RETRIEVAL_COMPARTMENT Function

CHANGE_AUDIT_POLICY_COMPARTMENT Function

CHANGE_AUDIT_PROFILE_COMPARTMENT Function

CHANGE_DATA_SAFE_PRIVATE_ENDPOINT_COMPARTMENT Function

CHANGE_DATABASE_SECURITY_CONFIG_COMPARTMENT Function

CHANGE_DISCOVERY_JOB_COMPARTMENT Function

CHANGE_LIBRARY_MASKING_FORMAT_COMPARTMENT Function

CHANGE_MASKING_POLICY_COMPARTMENT Function

CHANGE_ON_PREM_CONNECTOR_COMPARTMENT Function

CHANGE_REPORT_COMPARTMENT Function

CHANGE_REPORT_DEFINITION_COMPARTMENT Function

CHANGE_RETENTION Function

CHANGE_SDM_MASKING_POLICY_DIFFERENCE_COMPARTMENT Function

CHANGE_SECURITY_ASSESSMENT_COMPARTMENT Function

CHANGE_SECURITY_POLICY_COMPARTMENT Function

CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT Function

CHANGE_SENSITIVE_DATA_MODEL_COMPARTMENT Function

CHANGE_SENSITIVE_TYPE_COMPARTMENT Function

CHANGE_SQL_COLLECTION_COMPARTMENT Function

CHANGE_SQL_FIREWALL_POLICY_COMPARTMENT Function

CHANGE_TARGET_ALERT_POLICY_ASSOCIATION_COMPARTMENT Function

CHANGE_TARGET_DATABASE_COMPARTMENT Function

CHANGE_USER_ASSESSMENT_COMPARTMENT Function

COMPARE_SECURITY_ASSESSMENT Function

COMPARE_USER_ASSESSMENT Function

CREATE_AUDIT_ARCHIVE_RETRIEVAL Function

CREATE_DATA_SAFE_PRIVATE_ENDPOINT Function

CREATE_DISCOVERY_JOB Function

CREATE_LIBRARY_MASKING_FORMAT Function

CREATE_MASKING_COLUMN Function

CREATE_MASKING_POLICY Function

CREATE_ON_PREM_CONNECTOR Function

CREATE_REPORT_DEFINITION Function

CREATE_SDM_MASKING_POLICY_DIFFERENCE Function

CREATE_SECURITY_ASSESSMENT Function

CREATE_SENSITIVE_COLUMN Function

CREATE_SENSITIVE_DATA_MODEL Function

CREATE_SENSITIVE_TYPE Function

CREATE_SQL_COLLECTION Function

CREATE_TARGET_ALERT_POLICY_ASSOCIATION Function

CREATE_TARGET_DATABASE Function

CREATE_USER_ASSESSMENT Function

DEACTIVATE_TARGET_DATABASE Function

DELETE_AUDIT_ARCHIVE_RETRIEVAL Function

DELETE_AUDIT_TRAIL Function

DELETE_DATA_SAFE_PRIVATE_ENDPOINT Function

DELETE_DISCOVERY_JOB Function

DELETE_DISCOVERY_JOB_RESULT Function

DELETE_LIBRARY_MASKING_FORMAT Function

DELETE_MASKING_COLUMN Function

DELETE_MASKING_POLICY Function

DELETE_ON_PREM_CONNECTOR Function

DELETE_REPORT_DEFINITION Function

DELETE_SDM_MASKING_POLICY_DIFFERENCE Function

DELETE_SECURITY_ASSESSMENT Function

DELETE_SENSITIVE_COLUMN Function

DELETE_SENSITIVE_DATA_MODEL Function

DELETE_SENSITIVE_TYPE Function

DELETE_SQL_COLLECTION Function

DELETE_SQL_FIREWALL_POLICY Function

DELETE_TARGET_ALERT_POLICY_ASSOCIATION Function

DELETE_TARGET_DATABASE Function

DELETE_USER_ASSESSMENT Function

DISCOVER_AUDIT_TRAILS Function

DOWNLOAD_DISCOVERY_REPORT Function

DOWNLOAD_MASKING_LOG Function

DOWNLOAD_MASKING_POLICY Function

DOWNLOAD_MASKING_REPORT Function

DOWNLOAD_PRIVILEGE_SCRIPT Function

DOWNLOAD_SECURITY_ASSESSMENT_REPORT Function