DataSafeClient

class oci.data_safe.DataSafeClient(config, **kwargs)

APIs for using Oracle Data Safe.

Methods

__init__(config, **kwargs) Creates a new service client
activate_target_database(…) Reactivates a previously deactivated Data Safe target database.
add_masking_columns_from_sdm(…) Adds columns to the specified masking policy from the associated sensitive data model.
apply_discovery_job_results(…) Applies the results of a discovery job to the specified sensitive data model.
calculate_audit_volume_available(…) Calculates the volume of audit events available on the target database to be collected.
calculate_audit_volume_collected(…) Calculates the volume of audit events collected by data safe.
cancel_work_request(work_request_id, **kwargs) Cancel the given work request.
change_alert_compartment(alert_id, …) Moves the specified alert into a different compartment.
change_audit_archive_retrieval_compartment(…) Moves the archive retreival to the specified compartment.
change_audit_policy_compartment(…) Moves the specified audit policy and its dependent resources into a different compartment.
change_audit_profile_compartment(…) Moves the specified audit profile and its dependent resources into a different compartment.
change_data_safe_private_endpoint_compartment(…) Moves the Data Safe private endpoint and its dependent resources to the specified compartment.
change_discovery_job_compartment(…) Moves the specified discovery job and its dependent resources into a different compartment.
change_library_masking_format_compartment(…) Moves the specified library masking format into a different compartment.
change_masking_policy_compartment(…) Moves the specified masking policy and its dependent resources into a different compartment.
change_on_prem_connector_compartment(…) Moves the specified on-premises connector into a different compartment.
change_report_compartment(report_id, …) Moves a resource into a different compartment.
change_report_definition_compartment(…) Moves a resource into a different compartment.
change_retention(audit_profile_id, …) Change the online and offline months .
change_security_assessment_compartment(…) Moves the specified saved security assessment or future scheduled assessments into a different compartment.
change_sensitive_data_model_compartment(…) Moves the specified sensitive data model and its dependent resources into a different compartment.
change_sensitive_type_compartment(…) Moves the specified sensitive type into a different compartment.
change_target_alert_policy_association_compartment(…) Moves the specified target-alert policy Association into a different compartment.
change_target_database_compartment(…) Moves the Data Safe target database to the specified compartment.
change_user_assessment_compartment(…) Moves the specified saved user assessment or future scheduled assessments into a different compartment.
compare_security_assessment(…) Compares two security assessments.
compare_user_assessment(user_assessment_id, …) Compares two user assessments.
create_audit_archive_retrieval(…) Creates a work request to retrieve archived audit data.
create_data_safe_private_endpoint(…) Creates a new Data Safe private endpoint.
create_discovery_job(…) Performs incremental data discovery for the specified sensitive data model.
create_library_masking_format(…) Creates a new library masking format.
create_masking_column(…) Creates a new masking column in the specified masking policy.
create_masking_policy(…) Creates a new masking policy and associates it with a sensitive data model or a reference target database.
create_on_prem_connector(…) Creates a new on-premises connector.
create_report_definition(…) Creates a new report definition with parameters specified in the body.
create_security_assessment(…) Creates a new saved security assessment for one or multiple targets in a compartment.
create_sensitive_column(…) Creates a new sensitive column in the specified sensitive data model.
create_sensitive_data_model(…) Creates a new sensitive data model.
create_sensitive_type(…) Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category.
create_target_alert_policy_association(…) Creates a new target-alert policy association to track a alert policy applied on target.
create_target_database(…) Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.
create_user_assessment(…) Creates a new saved user assessment for one or multiple targets in a compartment.
deactivate_target_database(…) Deactivates a target database in Data Safe.
delete_audit_archive_retrieval(…) To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first.
delete_audit_trail(audit_trail_id, **kwargs) Deletes the specified audit trail.
delete_data_safe_private_endpoint(…) Deletes the specified Data Safe private endpoint.
delete_discovery_job(discovery_job_id, **kwargs) Deletes the specified discovery job.
delete_discovery_job_result(…) Deletes the specified discovery result.
delete_library_masking_format(…) Deletes the specified library masking format.
delete_masking_column(masking_column_key, …) Deletes the specified masking column.
delete_masking_policy(masking_policy_id, …) Deletes the specified masking policy.
delete_on_prem_connector(…) Deletes the specified on-premises connector.
delete_report_definition(…) Deletes the specified report definition.
delete_security_assessment(…) Deletes the specified saved security assessment or schedule.
delete_sensitive_column(…) Deletes the specified sensitive column.
delete_sensitive_data_model(…) Deletes the specified sensitive data model.
delete_sensitive_type(sensitive_type_id, …) Deletes the specified sensitive type.
delete_target_alert_policy_association(…) Deletes the specified target-alert policy Association.
delete_target_database(target_database_id, …) Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.
delete_user_assessment(user_assessment_id, …) Deletes the specified saved user assessment or schedule.
discover_audit_trails(audit_profile_id, **kwargs) 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.
download_discovery_report(…) Downloads an already-generated discovery report.
download_masking_log(masking_policy_id, …) Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.
download_masking_policy(masking_policy_id, …) Downloads an already-generated file corresponding to the specified masking policy.
download_masking_report(masking_policy_id, …) Downloads an already-generated masking report.
download_privilege_script(**kwargs) Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.
download_security_assessment_report(…) Downloads the report of the specified security assessment.
download_sensitive_data_model(…) Downloads an already-generated file corresponding to the specified sensitive data model.
download_user_assessment_report(…) Downloads the report of the specified user assessment.
enable_data_safe_configuration(…) Enables Data Safe in the tenancy and region.
generate_discovery_report_for_download(…) Generates a downloadable discovery report.
generate_masking_policy_for_download(…) Generates a downloadable file corresponding to the specified masking policy.
generate_masking_report_for_download(…) Generates a downloadable masking report.
generate_on_prem_connector_configuration(…) Creates and downloads the configuration of the specified on-premises connector.
generate_report(report_definition_id, …) Generates a PDF or XLS report based on parameters and report definition.
generate_security_assessment_report(…) Generates the report of the specified security assessment.
generate_sensitive_data_model_for_download(…) Generates a downloadable file corresponding to the specified sensitive data model.
generate_user_assessment_report(…) Generates the report of the specified user assessment.
get_alert(alert_id, **kwargs) Gets the details of alert by its ID.
get_alert_policy(alert_policy_id, **kwargs) Gets the details of alert policy by its ID.
get_audit_archive_retrieval(…) Gets the details of the specified archive retreival.
get_audit_policy(audit_policy_id, **kwargs) Gets a audit policy by identifier.
get_audit_profile(audit_profile_id, **kwargs) Gets the details of audit profile resource and associated audit trails of the audit profile.
get_audit_trail(audit_trail_id, **kwargs) Gets the details of audit trail.
get_compatible_formats_for_data_types(**kwargs) Gets a list of basic masking formats compatible with the supported data types.
get_compatible_formats_for_sensitive_types(…) Gets a list of library masking formats compatible with the existing sensitive types.
get_data_safe_configuration(**kwargs) Gets the details of the Data Safe configuration.
get_data_safe_private_endpoint(…) Gets the details of the specified Data Safe private endpoint.
get_discovery_job(discovery_job_id, **kwargs) Gets the details of the specified discovery job.
get_discovery_job_result(discovery_job_id, …) Gets the details of the specified discovery result.
get_library_masking_format(…) Gets the details of the specified library masking format.
get_masking_column(masking_policy_id, …) Gets the details of the specified masking column.
get_masking_policy(masking_policy_id, **kwargs) Gets the details of the specified masking policy.
get_masking_report(masking_report_id, **kwargs) Gets the details of the specified masking report.
get_on_prem_connector(on_prem_connector_id, …) Gets the details of the specified on-premises connector.
get_report(report_id, **kwargs) Gets a report by identifier
get_report_content(report_id, **kwargs) Downloads the specified report in the form of PDF or XLXS.
get_report_definition(report_definition_id, …) Gets the details of report definition specified by the identifier
get_security_assessment(…) Gets the details of the specified security assessment.
get_security_assessment_comparison(…) Gets the details of the comparison report on the security assessments submitted for comparison.
get_sensitive_column(…) Gets the details of the specified sensitive column.
get_sensitive_data_model(…) Gets the details of the specified sensitive data model.
get_sensitive_type(sensitive_type_id, **kwargs) Gets the details of the specified sensitive type.
get_target_alert_policy_association(…) Gets the details of target-alert policy association by its ID.
get_target_database(target_database_id, **kwargs) Returns the details of the specified Data Safe target database.
get_user_assessment(user_assessment_id, **kwargs) Gets a user assessment by identifier.
get_user_assessment_comparison(…) Gets the details of the comparison report for the user assessments provided.
get_work_request(work_request_id, **kwargs) Gets the details of the specified work request.
list_alert_analytics(compartment_id, **kwargs) Returns aggregation details of alerts.
list_alert_policies(compartment_id, **kwargs) Gets a list of all alert policies.
list_alert_policy_rules(alert_policy_id, …) Lists the rules of the specified alert policy.
list_alerts(compartment_id, **kwargs) Gets a list of all alerts.
list_audit_archive_retrievals(…) Returns the list of audit archive retrieval.
list_audit_event_analytics(compartment_id, …) By default ListAuditEventAnalytics operation will return all of the summary columns.
list_audit_events(compartment_id, **kwargs) The ListAuditEvents operation returns specified compartmentId audit Events only.
list_audit_policies(compartment_id, **kwargs) Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions.
list_audit_profile_analytics(compartment_id, …) Gets a list of audit profile aggregated details .
list_audit_profiles(compartment_id, **kwargs) Gets a list of all audit profiles.
list_audit_trail_analytics(compartment_id, …) Gets a list of audit trail aggregated details .
list_audit_trails(compartment_id, **kwargs) Gets a list of all audit trails.
list_available_audit_volumes(…) Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.
list_collected_audit_volumes(…) Gets a list of all collected audit volume data points.
list_columns(target_database_id, **kwargs) Returns a list of column metadata objects.
list_data_safe_private_endpoints(…) Gets a list of Data Safe private endpoints.
list_discovery_analytics(compartment_id, …) Gets consolidated discovery analytics data based on the specified query parameters.
list_discovery_job_results(discovery_job_id, …) Gets a list of discovery results based on the specified query parameters.
list_discovery_jobs(compartment_id, **kwargs) Gets a list of incremental discovery jobs based on the specified query parameters.
list_findings(security_assessment_id, **kwargs) List all the findings from all the targets in the specified assessment.
list_grants(user_assessment_id, user_key, …) Gets a list of grants for a particular user in the specified user assessment.
list_library_masking_formats(compartment_id, …) Gets a list of library masking formats based on the specified query parameters.
list_masked_columns(masking_report_id, **kwargs) Gets a list of masked columns present in the specified masking report and based on the specified query parameters.
list_masking_analytics(compartment_id, **kwargs) Gets consolidated masking analytics data based on the specified query parameters.
list_masking_columns(masking_policy_id, **kwargs) Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.
list_masking_policies(compartment_id, **kwargs) Gets a list of masking policies based on the specified query parameters.
list_masking_reports(compartment_id, **kwargs) Gets a list of masking reports based on the specified query parameters.
list_on_prem_connectors(compartment_id, **kwargs) Gets a list of on-premises connectors.
list_report_definitions(compartment_id, **kwargs) Gets a list of report definitions.
list_reports(compartment_id, **kwargs) Gets a list of all the reports in the compartment.
list_roles(target_database_id, **kwargs) Returns a list of role metadata objects.
list_schemas(target_database_id, **kwargs) Returns list of schema.
list_security_assessments(compartment_id, …) Gets a list of security assessments.
list_sensitive_columns(…) Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.
list_sensitive_data_models(compartment_id, …) Gets a list of sensitive data models based on the specified query parameters.
list_sensitive_types(compartment_id, **kwargs) Gets a list of sensitive types based on the specified query parameters.
list_tables(target_database_id, **kwargs) Returns a list of table metadata objects.
list_target_alert_policy_associations(…) Gets a list of all target-alert policy associations.
list_target_databases(compartment_id, **kwargs) Returns the list of registered target databases in Data Safe.
list_user_analytics(user_assessment_id, **kwargs) Gets a list of aggregated user details from the specified user assessment.
list_user_assessments(compartment_id, **kwargs) Gets a list of user assessments.
list_users(user_assessment_id, **kwargs) Gets a list of users of the specified user assessment.
list_work_request_errors(work_request_id, …) Gets a list of errors for the specified work request.
list_work_request_logs(work_request_id, **kwargs) Gets a list of log entries for the specified work request.
list_work_requests(compartment_id, **kwargs) Gets a list of work requests.
mask_data(masking_policy_id, …) Masks data using the specified masking policy.
modify_global_settings(…) Modifies Global Settings in Data Safe in the tenancy and region.
patch_alerts(patch_alerts_details, **kwargs) Patch alerts.
patch_discovery_job_results(…) Patches one or more discovery results.
patch_masking_columns(masking_policy_id, …) Patches one or more columns in the specified masking policy.
patch_sensitive_columns(…) Patches one or more columns in the specified sensitive data model.
provision_audit_policy(…) Provision audit policy.
refresh_security_assessment(…) Runs a security assessment, refreshes the latest assessment, and saves it for future reference.
refresh_user_assessment(user_assessment_id, …) Refreshes the latest assessment and saves it for future reference.
resume_audit_trail(audit_trail_id, **kwargs) Resumes the specified audit trail once it got stopped.
resume_work_request(work_request_id, **kwargs) Resume the given work request.
retrieve_audit_policies(audit_policy_id, …) Retrieves the audit policy details from the source target database.
set_security_assessment_baseline(…) Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides.
set_user_assessment_baseline(…) Sets the saved user assessment as the baseline in the compartment where the specified assessment resides.
start_audit_trail(start_audit_trail_details, …) Starts collection of audit records on the specified audit trail.
stop_audit_trail(audit_trail_id, **kwargs) Stops the specified audit trail.
suspend_work_request(work_request_id, **kwargs) Suspend the given work request.
unset_security_assessment_baseline(…) Removes the baseline setting for the saved security assessment.
unset_user_assessment_baseline(…) Removes the baseline setting for the saved user assessment.
update_alert(alert_id, update_alert_details, …) Updates alert status of the specified alert.
update_audit_archive_retrieval(…) Updates the audit archive retrieval.
update_audit_policy(audit_policy_id, …) Updates the audit policy.
update_audit_profile(audit_profile_id, …) Updates one or more attributes of the specified audit profile.
update_audit_trail(audit_trail_id, …) Updates one or more attributes of the specified audit trail.
update_data_safe_private_endpoint(…) Updates one or more attributes of the specified Data Safe private endpoint.
update_library_masking_format(…) Updates one or more attributes of the specified library masking format.
update_masking_column(masking_column_key, …) Updates one or more attributes of the specified masking column.
update_masking_policy(masking_policy_id, …) Updates one or more attributes of the specified masking policy.
update_on_prem_connector(…) Updates one or more attributes of the specified on-premises connector.
update_on_prem_connector_wallet(…) Updates the wallet for the specified on-premises connector to a new version.
update_report_definition(…) Updates the specified report definition.
update_security_assessment(…) Updates one or more attributes of the specified security assessment.
update_sensitive_column(…) Updates one or more attributes of the specified sensitive column.
update_sensitive_data_model(…) Updates one or more attributes of the specified sensitive data model.
update_sensitive_type(sensitive_type_id, …) Updates one or more attributes of the specified sensitive type.
update_target_alert_policy_association(…) Updates the specified target-alert policy association.
update_target_database(target_database_id, …) Updates one or more attributes of the specified Data Safe target database.
update_user_assessment(user_assessment_id, …) Updates one or more attributes of the specified user assessment.
upload_masking_policy(…) Uploads a masking policy file (also called template) to update the specified masking policy.
upload_sensitive_data_model(…) Uploads a sensitive data model file (also called template) to update the specified sensitive data model.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
activate_target_database(activate_target_database_details, target_database_id, **kwargs)

Reactivates a previously deactivated Data Safe target database.

Parameters:
  • activate_target_database_details (oci.data_safe.models.ActivateTargetDatabaseDetails) – (required) The details used to reactivate a target database in Data Safe.
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_retry_token (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use activate_target_database API.

add_masking_columns_from_sdm(masking_policy_id, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_masking_columns_from_sdm API.

apply_discovery_job_results(sensitive_data_model_id, apply_discovery_job_results_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • apply_discovery_job_results_details (oci.data_safe.models.ApplyDiscoveryJobResultsDetails) – (required) Details to apply the discovery results to a sensitive data model.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use apply_discovery_job_results API.

calculate_audit_volume_available(audit_profile_id, calculate_audit_volume_available_details, **kwargs)

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.

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • calculate_audit_volume_available_details (oci.data_safe.models.CalculateAuditVolumeAvailableDetails) – (required) Details for the calculation of audit volume available on target database.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use calculate_audit_volume_available API.

calculate_audit_volume_collected(audit_profile_id, calculate_audit_volume_collected_details, **kwargs)

Calculates the volume of audit events collected by data safe.

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • calculate_audit_volume_collected_details (oci.data_safe.models.CalculateAuditVolumeCollectedDetails) – (required) Details for the calculation of audit volume collected by data safe.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use calculate_audit_volume_collected API.

cancel_work_request(work_request_id, **kwargs)

Cancel the given work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use cancel_work_request API.

change_alert_compartment(alert_id, change_alert_compartment_details, **kwargs)

Moves the specified alert into a different compartment.

Parameters:
  • alert_id (str) – (required) The OCID of alert.
  • change_alert_compartment_details (oci.data_safe.models.ChangeAlertCompartmentDetails) – (required) The details used to change the compartment of an alert.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_alert_compartment API.

change_audit_archive_retrieval_compartment(audit_archive_retrieval_id, change_audit_archive_retrieval_compartment_details, **kwargs)

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

Parameters:
  • audit_archive_retrieval_id (str) – (required) OCID of the archive retrieval.
  • change_audit_archive_retrieval_compartment_details (oci.data_safe.models.ChangeAuditArchiveRetrievalCompartmentDetails) – (required) The details used to change the compartment of a archive retrieval.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_audit_archive_retrieval_compartment API.

change_audit_policy_compartment(audit_policy_id, change_audit_policy_compartment_details, **kwargs)

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

Parameters:
  • audit_policy_id (str) – (required) Unique audit policy identifier.
  • change_audit_policy_compartment_details (oci.data_safe.models.ChangeAuditPolicyCompartmentDetails) – (required) Details for the compartment move.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_audit_policy_compartment API.

change_audit_profile_compartment(audit_profile_id, change_audit_profile_compartment_details, **kwargs)

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

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • change_audit_profile_compartment_details (oci.data_safe.models.ChangeAuditProfileCompartmentDetails) – (required) Details for the compartment move.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_audit_profile_compartment API.

change_data_safe_private_endpoint_compartment(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, **kwargs)

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

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • change_data_safe_private_endpoint_compartment_details (oci.data_safe.models.ChangeDataSafePrivateEndpointCompartmentDetails) – (required) The details used to change the compartment of a Data Safe private endpoint.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_data_safe_private_endpoint_compartment API.

change_discovery_job_compartment(discovery_job_id, change_discovery_job_compartment_details, **kwargs)

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

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • change_discovery_job_compartment_details (oci.data_safe.models.ChangeDiscoveryJobCompartmentDetails) – (required) The details used to change the compartment of a resource.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_discovery_job_compartment API.

change_library_masking_format_compartment(library_masking_format_id, change_library_masking_format_compartment_details, **kwargs)

Moves the specified library masking format into a different compartment.

Parameters:
  • library_masking_format_id (str) – (required) The OCID of the library masking format.
  • change_library_masking_format_compartment_details (oci.data_safe.models.ChangeLibraryMaskingFormatCompartmentDetails) – (required) Details to change the compartment of a library masking format.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_library_masking_format_compartment API.

change_masking_policy_compartment(masking_policy_id, change_masking_policy_compartment_details, **kwargs)

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

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • change_masking_policy_compartment_details (oci.data_safe.models.ChangeMaskingPolicyCompartmentDetails) – (required) Details to change the compartment of a masking policy.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_masking_policy_compartment API.

change_on_prem_connector_compartment(on_prem_connector_id, change_on_prem_connector_compartment_details, **kwargs)

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

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • change_on_prem_connector_compartment_details (oci.data_safe.models.ChangeOnPremConnectorCompartmentDetails) – (required) The details used to change the compartment of an on-premises connector.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_on_prem_connector_compartment API.

change_report_compartment(report_id, change_report_compartment_details, **kwargs)

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

Parameters:
  • report_id (str) – (required) Unique report identifier
  • change_report_compartment_details (oci.data_safe.models.ChangeReportCompartmentDetails) – (required) Details for the different Report.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_report_compartment API.

change_report_definition_compartment(report_definition_id, change_report_definition_compartment_details, **kwargs)

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

Parameters:
  • report_definition_id (str) – (required) Unique report definition identifier
  • change_report_definition_compartment_details (oci.data_safe.models.ChangeReportDefinitionCompartmentDetails) – (required) Details for the different ReportDefinition.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_report_definition_compartment API.

change_retention(audit_profile_id, change_retention_details, **kwargs)

Change the online and offline months .

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • change_retention_details (oci.data_safe.models.ChangeRetentionDetails) – (required) Details for the audit retention months to be modified.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_retention API.

change_security_assessment_compartment(security_assessment_id, change_security_assessment_compartment_details, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • change_security_assessment_compartment_details (oci.data_safe.models.ChangeSecurityAssessmentCompartmentDetails) – (required) The details used to change the compartment of a security assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_security_assessment_compartment API.

change_sensitive_data_model_compartment(sensitive_data_model_id, change_sensitive_data_model_compartment_details, **kwargs)

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

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • change_sensitive_data_model_compartment_details (oci.data_safe.models.ChangeSensitiveDataModelCompartmentDetails) – (required) Details to change the compartment of a sensitive data model.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_sensitive_data_model_compartment API.

change_sensitive_type_compartment(sensitive_type_id, change_sensitive_type_compartment_details, **kwargs)

Moves the specified sensitive type into a different compartment.

Parameters:
  • sensitive_type_id (str) – (required) The OCID of the sensitive type.
  • change_sensitive_type_compartment_details (oci.data_safe.models.ChangeSensitiveTypeCompartmentDetails) – (required) Details to change the compartment of a sensitive type.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_sensitive_type_compartment API.

change_target_alert_policy_association_compartment(target_alert_policy_association_id, change_target_alert_policy_association_compartment_details, **kwargs)

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

Parameters:
  • target_alert_policy_association_id (str) – (required) The OCID of the target-alert policy association.
  • change_target_alert_policy_association_compartment_details (oci.data_safe.models.ChangeTargetAlertPolicyAssociationCompartmentDetails) – (required) The details used to change the compartment of a target-alert policy association.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_target_alert_policy_association_compartment API.

change_target_database_compartment(target_database_id, change_target_database_compartment_details, **kwargs)

Moves the Data Safe target database to the specified compartment.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • change_target_database_compartment_details (oci.data_safe.models.ChangeTargetDatabaseCompartmentDetails) – (required) Details of the move compartment request.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_target_database_compartment API.

change_user_assessment_compartment(user_assessment_id, change_user_assessment_compartment_details, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • change_user_assessment_compartment_details (oci.data_safe.models.ChangeUserAssessmentCompartmentDetails) – (required) The details used to change the compartment of a user assessment.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_user_assessment_compartment API.

compare_security_assessment(security_assessment_id, compare_security_assessment_details, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • compare_security_assessment_details (oci.data_safe.models.CompareSecurityAssessmentDetails) – (required) Details of the security assessment comparison.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use compare_security_assessment API.

compare_user_assessment(user_assessment_id, compare_user_assessment_details, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • compare_user_assessment_details (oci.data_safe.models.CompareUserAssessmentDetails) – (required) Details of the user assessment comparison.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use compare_user_assessment API.

create_audit_archive_retrieval(create_audit_archive_retrieval_details, **kwargs)

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.

Parameters:
  • create_audit_archive_retrieval_details (oci.data_safe.models.CreateAuditArchiveRetrievalDetails) – (required) Details for creating retrieving archived audit data.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditArchiveRetrieval

Return type:

Response

Example:

Click here to see an example of how to use create_audit_archive_retrieval API.

create_data_safe_private_endpoint(create_data_safe_private_endpoint_details, **kwargs)

Creates a new Data Safe private endpoint.

Parameters:
  • create_data_safe_private_endpoint_details (oci.data_safe.models.CreateDataSafePrivateEndpointDetails) – (required) Details to create a new private endpoint.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DataSafePrivateEndpoint

Return type:

Response

Example:

Click here to see an example of how to use create_data_safe_private_endpoint API.

create_discovery_job(create_discovery_job_details, **kwargs)

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.

Parameters:
  • create_discovery_job_details (oci.data_safe.models.CreateDiscoveryJobDetails) – (required) The details used to run an incremental data discovery job
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryJob

Return type:

Response

Example:

Click here to see an example of how to use create_discovery_job API.

create_library_masking_format(create_library_masking_format_details, **kwargs)

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.

Parameters:
  • create_library_masking_format_details (oci.data_safe.models.CreateLibraryMaskingFormatDetails) – (required) Details to create a new library masking format.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type LibraryMaskingFormat

Return type:

Response

Example:

Click here to see an example of how to use create_library_masking_format API.

create_masking_column(create_masking_column_details, masking_policy_id, **kwargs)

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.

Parameters:
  • create_masking_column_details (oci.data_safe.models.CreateMaskingColumnDetails) – (required) Details to create a new masking column.
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_masking_column API.

create_masking_policy(create_masking_policy_details, **kwargs)

Creates a new masking policy and associates it with a sensitive data model or a reference 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.

Parameters:
  • create_masking_policy_details (oci.data_safe.models.CreateMaskingPolicyDetails) – (required) Details to create a new masking policy.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingPolicy

Return type:

Response

Example:

Click here to see an example of how to use create_masking_policy API.

create_on_prem_connector(create_on_prem_connector_details, **kwargs)

Creates a new on-premises connector.

Parameters:
  • create_on_prem_connector_details (oci.data_safe.models.CreateOnPremConnectorDetails) – (required) The details used to create a new on-premises connector.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type OnPremConnector

Return type:

Response

Example:

Click here to see an example of how to use create_on_prem_connector API.

create_report_definition(create_report_definition_details, **kwargs)

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

Parameters:
  • create_report_definition_details (oci.data_safe.models.CreateReportDefinitionDetails) – (required) Details for the new report definition.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ReportDefinition

Return type:

Response

Example:

Click here to see an example of how to use create_report_definition API.

create_security_assessment(create_security_assessment_details, **kwargs)

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.

Parameters:
  • create_security_assessment_details (oci.data_safe.models.CreateSecurityAssessmentDetails) – (required) The details used to create a new saved security assessment.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SecurityAssessment

Return type:

Response

Example:

Click here to see an example of how to use create_security_assessment API.

create_sensitive_column(sensitive_data_model_id, create_sensitive_column_details, **kwargs)

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

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • create_sensitive_column_details (oci.data_safe.models.CreateSensitiveColumnDetails) – (required) Details to create a new sensitive column.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_sensitive_column API.

create_sensitive_data_model(create_sensitive_data_model_details, **kwargs)

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.

Parameters:
  • create_sensitive_data_model_details (oci.data_safe.models.CreateSensitiveDataModelDetails) – (required) Details to create a new sensitive data model.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveDataModel

Return type:

Response

Example:

Click here to see an example of how to use create_sensitive_data_model API.

create_sensitive_type(create_sensitive_type_details, **kwargs)

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.

Parameters:
  • create_sensitive_type_details (oci.data_safe.models.CreateSensitiveTypeDetails) – (required) Details to create a new sensitive type.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveType

Return type:

Response

Example:

Click here to see an example of how to use create_sensitive_type API.

create_target_alert_policy_association(create_target_alert_policy_association_details, **kwargs)

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

Parameters:
  • create_target_alert_policy_association_details (oci.data_safe.models.CreateTargetAlertPolicyAssociationDetails) – (required) The details used to create a new target-alert policy association.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TargetAlertPolicyAssociation

Return type:

Response

Example:

Click here to see an example of how to use create_target_alert_policy_association API.

create_target_database(create_target_database_details, **kwargs)

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

Parameters:
  • create_target_database_details (oci.data_safe.models.CreateTargetDatabaseDetails) – (required) Details of the target database.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TargetDatabase

Return type:

Response

Example:

Click here to see an example of how to use create_target_database API.

create_user_assessment(create_user_assessment_details, **kwargs)

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.

Parameters:
  • create_user_assessment_details (oci.data_safe.models.CreateUserAssessmentDetails) – (required) The details used to create a new saved user assessment.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type UserAssessment

Return type:

Response

Example:

Click here to see an example of how to use create_user_assessment API.

deactivate_target_database(target_database_id, **kwargs)

Deactivates a target database in Data Safe.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_retry_token (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use deactivate_target_database API.

delete_audit_archive_retrieval(audit_archive_retrieval_id, **kwargs)

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

Parameters:
  • audit_archive_retrieval_id (str) – (required) OCID of the archive retrieval.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_audit_archive_retrieval API.

delete_audit_trail(audit_trail_id, **kwargs)

Deletes the specified audit trail.

Parameters:
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_audit_trail API.

delete_data_safe_private_endpoint(data_safe_private_endpoint_id, **kwargs)

Deletes the specified Data Safe private endpoint.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_data_safe_private_endpoint API.

delete_discovery_job(discovery_job_id, **kwargs)

Deletes the specified discovery job.

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_discovery_job API.

delete_discovery_job_result(discovery_job_id, result_key, **kwargs)

Deletes the specified discovery result.

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • result_key (str) – (required) The unique key that identifies the discovery result.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_discovery_job_result API.

delete_library_masking_format(library_masking_format_id, **kwargs)

Deletes the specified library masking format.

Parameters:
  • library_masking_format_id (str) – (required) The OCID of the library masking format.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_library_masking_format API.

delete_masking_column(masking_column_key, masking_policy_id, **kwargs)

Deletes the specified masking column.

Parameters:
  • masking_column_key (str) – (required) The unique key that identifies the masking column. It’s numeric and unique within a masking policy.
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_masking_column API.

delete_masking_policy(masking_policy_id, **kwargs)

Deletes the specified masking policy.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_masking_policy API.

delete_on_prem_connector(on_prem_connector_id, **kwargs)

Deletes the specified on-premises connector.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_on_prem_connector API.

delete_report_definition(report_definition_id, **kwargs)

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

Parameters:
  • report_definition_id (str) – (required) Unique report definition identifier
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_report_definition API.

delete_security_assessment(security_assessment_id, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_security_assessment API.

delete_sensitive_column(sensitive_data_model_id, sensitive_column_key, **kwargs)

Deletes the specified sensitive column.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • sensitive_column_key (str) – (required) The unique key that identifies the sensitive column. It’s numeric and unique within a sensitive data model.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_sensitive_column API.

delete_sensitive_data_model(sensitive_data_model_id, **kwargs)

Deletes the specified sensitive data model.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_sensitive_data_model API.

delete_sensitive_type(sensitive_type_id, **kwargs)

Deletes the specified sensitive type.

Parameters:
  • sensitive_type_id (str) – (required) The OCID of the sensitive type.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_sensitive_type API.

delete_target_alert_policy_association(target_alert_policy_association_id, **kwargs)

Deletes the specified target-alert policy Association.

Parameters:
  • target_alert_policy_association_id (str) – (required) The OCID of the target-alert policy association.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_target_alert_policy_association API.

delete_target_database(target_database_id, **kwargs)

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

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_target_database API.

delete_user_assessment(user_assessment_id, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_user_assessment API.

discover_audit_trails(audit_profile_id, **kwargs)

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.

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use discover_audit_trails API.

download_discovery_report(sensitive_data_model_id, download_discovery_report_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • download_discovery_report_details (oci.data_safe.models.DownloadDiscoveryReportDetails) – (required) Details to download a discovery report.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_discovery_report API.

download_masking_log(masking_policy_id, download_masking_log_details, **kwargs)

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

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • download_masking_log_details (oci.data_safe.models.DownloadMaskingLogDetails) – (required) Details to download masking log.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_masking_log API.

download_masking_policy(masking_policy_id, download_masking_policy_details, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • download_masking_policy_details (oci.data_safe.models.DownloadMaskingPolicyDetails) – (required) Details to download a masking policy file.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_masking_policy API.

download_masking_report(masking_policy_id, download_masking_report_details, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • download_masking_report_details (oci.data_safe.models.DownloadMaskingReportDetails) – (required) Details to download a masking report.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_masking_report API.

download_privilege_script(**kwargs)

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

Parameters:
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_privilege_script API.

download_security_assessment_report(security_assessment_id, download_security_assessment_report_details, **kwargs)

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

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • download_security_assessment_report_details (oci.data_safe.models.DownloadSecurityAssessmentReportDetails) – (required) Details of the report.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_security_assessment_report API.

download_sensitive_data_model(sensitive_data_model_id, download_sensitive_data_model_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • download_sensitive_data_model_details (oci.data_safe.models.DownloadSensitiveDataModelDetails) – (required) Details to download a sensitive data model file.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_sensitive_data_model API.

download_user_assessment_report(user_assessment_id, download_user_assessment_report_details, **kwargs)

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

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • download_user_assessment_report_details (oci.data_safe.models.DownloadUserAssessmentReportDetails) – (required) Details of the report.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_user_assessment_report API.

enable_data_safe_configuration(enable_data_safe_configuration_details, **kwargs)

Enables Data Safe in the tenancy and region.

Parameters:
  • enable_data_safe_configuration_details (oci.data_safe.models.EnableDataSafeConfigurationDetails) – (required) The details used to enable Data Safe.
  • compartment_id (str) – (optional) A filter to return only resources that match the specified compartment OCID.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_data_safe_configuration API.

generate_discovery_report_for_download(sensitive_data_model_id, generate_discovery_report_for_download_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • generate_discovery_report_for_download_details (oci.data_safe.models.GenerateDiscoveryReportForDownloadDetails) – (required) Details to generate a downloadable discovery report.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_discovery_report_for_download API.

generate_masking_policy_for_download(masking_policy_id, generate_masking_policy_for_download_details, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • generate_masking_policy_for_download_details (oci.data_safe.models.GenerateMaskingPolicyForDownloadDetails) – (required) Details to generate a masking policy file.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_masking_policy_for_download API.

generate_masking_report_for_download(masking_policy_id, generate_masking_report_for_download_details, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • generate_masking_report_for_download_details (oci.data_safe.models.GenerateMaskingReportForDownloadDetails) – (required) Details to generate a downloadable masking report.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_masking_report_for_download API.

generate_on_prem_connector_configuration(generate_on_prem_connector_configuration_details, on_prem_connector_id, **kwargs)

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

Parameters:
  • generate_on_prem_connector_configuration_details (oci.data_safe.models.GenerateOnPremConnectorConfigurationDetails) – (required) The details used to create and download on-premises connector’s configuration.
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use generate_on_prem_connector_configuration API.

generate_report(report_definition_id, generate_report_details, **kwargs)

Generates a PDF or XLS report based on parameters and report definition.

Parameters:
  • report_definition_id (str) – (required) Unique report definition identifier
  • generate_report_details (oci.data_safe.models.GenerateReportDetails) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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 (str) –

    (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’)

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_report API.

generate_security_assessment_report(security_assessment_id, generate_security_assessment_report_details, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • generate_security_assessment_report_details (oci.data_safe.models.GenerateSecurityAssessmentReportDetails) – (required) Details of the report.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_security_assessment_report API.

generate_sensitive_data_model_for_download(sensitive_data_model_id, generate_sensitive_data_model_for_download_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • generate_sensitive_data_model_for_download_details (oci.data_safe.models.GenerateSensitiveDataModelForDownloadDetails) – (required) Details to generate a sensitive data model file.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_sensitive_data_model_for_download API.

generate_user_assessment_report(user_assessment_id, generate_user_assessment_report_details, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • generate_user_assessment_report_details (oci.data_safe.models.GenerateUserAssessmentReportDetails) – (required) Details of the report.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use generate_user_assessment_report API.

get_alert(alert_id, **kwargs)

Gets the details of alert by its ID.

Parameters:
  • alert_id (str) – (required) The OCID of alert.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Alert

Return type:

Response

Example:

Click here to see an example of how to use get_alert API.

get_alert_policy(alert_policy_id, **kwargs)

Gets the details of alert policy by its ID.

Parameters:
  • alert_policy_id (str) – (required) The OCID of the alert policy.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertPolicy

Return type:

Response

Example:

Click here to see an example of how to use get_alert_policy API.

get_audit_archive_retrieval(audit_archive_retrieval_id, **kwargs)

Gets the details of the specified archive retreival.

Parameters:
  • audit_archive_retrieval_id (str) – (required) OCID of the archive retrieval.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditArchiveRetrieval

Return type:

Response

Example:

Click here to see an example of how to use get_audit_archive_retrieval API.

get_audit_policy(audit_policy_id, **kwargs)

Gets a audit policy by identifier.

Parameters:
  • audit_policy_id (str) – (required) Unique audit policy identifier.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditPolicy

Return type:

Response

Example:

Click here to see an example of how to use get_audit_policy API.

get_audit_profile(audit_profile_id, **kwargs)

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

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditProfile

Return type:

Response

Example:

Click here to see an example of how to use get_audit_profile API.

get_audit_trail(audit_trail_id, **kwargs)

Gets the details of audit trail.

Parameters:
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditTrail

Return type:

Response

Example:

Click here to see an example of how to use get_audit_trail API.

get_compatible_formats_for_data_types(**kwargs)

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

Parameters:
  • limit (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CompatibleFormatsForDataTypes

Return type:

Response

Example:

Click here to see an example of how to use get_compatible_formats_for_data_types API.

get_compatible_formats_for_sensitive_types(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CompatibleFormatsForSensitiveTypes

Return type:

Response

Example:

Click here to see an example of how to use get_compatible_formats_for_sensitive_types API.

get_data_safe_configuration(**kwargs)

Gets the details of the Data Safe configuration.

Parameters:
  • compartment_id (str) – (optional) A filter to return only resources that match the specified compartment OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DataSafeConfiguration

Return type:

Response

Example:

Click here to see an example of how to use get_data_safe_configuration API.

get_data_safe_private_endpoint(data_safe_private_endpoint_id, **kwargs)

Gets the details of the specified Data Safe private endpoint.

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DataSafePrivateEndpoint

Return type:

Response

Example:

Click here to see an example of how to use get_data_safe_private_endpoint API.

get_discovery_job(discovery_job_id, **kwargs)

Gets the details of the specified discovery job.

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryJob

Return type:

Response

Example:

Click here to see an example of how to use get_discovery_job API.

get_discovery_job_result(discovery_job_id, result_key, **kwargs)

Gets the details of the specified discovery result.

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • result_key (str) – (required) The unique key that identifies the discovery result.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryJobResult

Return type:

Response

Example:

Click here to see an example of how to use get_discovery_job_result API.

get_library_masking_format(library_masking_format_id, **kwargs)

Gets the details of the specified library masking format.

Parameters:
  • library_masking_format_id (str) – (required) The OCID of the library masking format.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type LibraryMaskingFormat

Return type:

Response

Example:

Click here to see an example of how to use get_library_masking_format API.

get_masking_column(masking_policy_id, masking_column_key, **kwargs)

Gets the details of the specified masking column.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • masking_column_key (str) – (required) The unique key that identifies the masking column. It’s numeric and unique within a masking policy.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingColumn

Return type:

Response

Example:

Click here to see an example of how to use get_masking_column API.

get_masking_policy(masking_policy_id, **kwargs)

Gets the details of the specified masking policy.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingPolicy

Return type:

Response

Example:

Click here to see an example of how to use get_masking_policy API.

get_masking_report(masking_report_id, **kwargs)

Gets the details of the specified masking report.

Parameters:
  • masking_report_id (str) – (required) The OCID of the masking report.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingReport

Return type:

Response

Example:

Click here to see an example of how to use get_masking_report API.

get_on_prem_connector(on_prem_connector_id, **kwargs)

Gets the details of the specified on-premises connector.

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type OnPremConnector

Return type:

Response

Example:

Click here to see an example of how to use get_on_prem_connector API.

get_report(report_id, **kwargs)

Gets a report by identifier

Parameters:
  • report_id (str) – (required) Unique report identifier
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Report

Return type:

Response

Example:

Click here to see an example of how to use get_report API.

get_report_content(report_id, **kwargs)

Downloads the specified report in the form of PDF or XLXS.

Parameters:
  • report_id (str) – (required) Unique report identifier
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_report_content API.

get_report_definition(report_definition_id, **kwargs)

Gets the details of report definition specified by the identifier

Parameters:
  • report_definition_id (str) – (required) Unique report definition identifier
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ReportDefinition

Return type:

Response

Example:

Click here to see an example of how to use get_report_definition API.

get_security_assessment(security_assessment_id, **kwargs)

Gets the details of the specified security assessment.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SecurityAssessment

Return type:

Response

Example:

Click here to see an example of how to use get_security_assessment API.

get_security_assessment_comparison(security_assessment_id, comparison_security_assessment_id, **kwargs)

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

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • comparison_security_assessment_id (str) – (required) The OCID of the baseline security assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SecurityAssessmentComparison

Return type:

Response

Example:

Click here to see an example of how to use get_security_assessment_comparison API.

get_sensitive_column(sensitive_data_model_id, sensitive_column_key, **kwargs)

Gets the details of the specified sensitive column.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • sensitive_column_key (str) – (required) The unique key that identifies the sensitive column. It’s numeric and unique within a sensitive data model.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveColumn

Return type:

Response

Example:

Click here to see an example of how to use get_sensitive_column API.

get_sensitive_data_model(sensitive_data_model_id, **kwargs)

Gets the details of the specified sensitive data model.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveDataModel

Return type:

Response

Example:

Click here to see an example of how to use get_sensitive_data_model API.

get_sensitive_type(sensitive_type_id, **kwargs)

Gets the details of the specified sensitive type.

Parameters:
  • sensitive_type_id (str) – (required) The OCID of the sensitive type.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveType

Return type:

Response

Example:

Click here to see an example of how to use get_sensitive_type API.

get_target_alert_policy_association(target_alert_policy_association_id, **kwargs)

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

Parameters:
  • target_alert_policy_association_id (str) – (required) The OCID of the target-alert policy association.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TargetAlertPolicyAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_target_alert_policy_association API.

get_target_database(target_database_id, **kwargs)

Returns the details of the specified Data Safe target database.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TargetDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_target_database API.

get_user_assessment(user_assessment_id, **kwargs)

Gets a user assessment by identifier.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type UserAssessment

Return type:

Response

Example:

Click here to see an example of how to use get_user_assessment API.

get_user_assessment_comparison(user_assessment_id, comparison_user_assessment_id, **kwargs)

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

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • comparison_user_assessment_id (str) – (required) The OCID of the baseline user assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type UserAssessmentComparison

Return type:

Response

Example:

Click here to see an example of how to use get_user_assessment_comparison API.

get_work_request(work_request_id, **kwargs)

Gets the details of the specified work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_alert_analytics(compartment_id, **kwargs)

Returns aggregation details of alerts.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (datetime) –

    (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 (datetime) –

    (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 (str) – (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) –

    (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 (str) –

    (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’) Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated

  • summary_field (list[str]) –

    (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 (list[str]) –

    (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertAnalyticsCollection

Return type:

Response

Example:

Click here to see an example of how to use list_alert_analytics API.

list_alert_policies(compartment_id, **kwargs)

Gets a list of all alert policies.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • alert_policy_id (str) – (optional) A filter to return policy by it’s OCID.
  • type (str) –

    (optional) An optional filter to return only alert policies of a certain type.

    Allowed values are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”

  • is_user_defined (bool) – (optional) An optional filter to return only alert policies that are user-defined or not.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • lifecycle_state (str) –

    (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 (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided.

    Allowed values are: “displayName”, “timeCreated”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • time_created_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (bool) – (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 (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertPolicyCollection

Return type:

Response

Example:

Click here to see an example of how to use list_alert_policies API.

list_alert_policy_rules(alert_policy_id, **kwargs)

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.

Parameters:
  • alert_policy_id (str) – (required) The OCID of the alert policy.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertPolicyRuleCollection

Return type:

Response

Example:

Click here to see an example of how to use list_alert_policy_rules API.

list_alerts(compartment_id, **kwargs)

Gets a list of all alerts.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • id (str) – (optional) A filter to return alert by it’s OCID.
  • compartment_id_in_subtree (bool) – (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 (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • access_level (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) –

    (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’) Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated

  • field (list[str]) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertCollection

Return type:

Response

Example:

Click here to see an example of how to use list_alerts API.

list_audit_archive_retrievals(compartment_id, **kwargs)

Returns the list of audit archive retrieval.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) OCID of the archive retrieval.
  • target_id (str) – (optional) The OCID of the target associated with the archive retrieval.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) A filter to return only resources that matches the specified lifecycle state.

    Allowed values are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “FAILED”, “DELETING”, “DELETED”

  • time_of_expiry (datetime) – (optional) The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditArchiveRetrievalCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_archive_retrievals API.

list_audit_event_analytics(compartment_id, **kwargs)

By default ListAuditEventAnalytics operation will return all of the summary columns. To filter desired summary columns, specify it in the summaryOf query parameter.

Example: /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostName&summaryField
&summaryField=dmls&summaryField=privilege_changes&summaryField=ddls&summaryField=login_failure&summaryField=login_success &summaryField=eventcount&q=(operationTime ge ‘2021-06-13T23:49:14’)&groupBy=targetName
Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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 (int) –

    (optional) For details about how pagination works, see List Pagination.

  • page (str) –

    (optional) It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) –

    (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 (list[str]) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (str) – (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 (list[str]) –

    (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 (str) – (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditEventAnalyticsCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_event_analytics API.

list_audit_events(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (int) –

    (optional) For details about how pagination works, see List Pagination.

  • page (str) –

    (optional) It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

  • scim_query (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditEventCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_events API.

list_audit_policies(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • limit (int) –

    (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 (str) –

    (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 (str) – (optional) A filter to return only items related to a specific target OCID.
  • lifecycle_state (str) –

    (optional) The current state of the audit policy.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”

  • audit_policy_id (str) – (optional) An optional filter to return only resources that match the specified id.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditPolicyCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_policies API.

list_audit_profile_analytics(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (int) –

    (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 (str) –

    (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 (list[str]) –

    (optional) The group by parameter for summarize operation on audit.

    Allowed values are: “isPaidUsageEnabled”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditProfileAnalyticCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_profile_analytics API.

list_audit_profiles(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A optional filter to return only resources that match the specified id.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (bool) – (optional) A optional filter to return only resources that match the specified retention configured value.
  • is_paid_usage_enabled (bool) – (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 (int) – (optional) A filter to return only items that have count of audit records collected greater than or equal to the specified value.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditProfileCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_profiles API.

list_audit_trail_analytics(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (int) –

    (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 (str) –

    (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 (list[str]) –

    (optional) The group by parameter for summarize operation on audit trail.

    Allowed values are: “location”, “lifecycleState”, “status”, “targetId”

  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditTrailAnalyticCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_trail_analytics API.

list_audit_trails(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A optional filter to return only resources that match the specified id.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (str) –

    (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”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuditTrailCollection

Return type:

Response

Example:

Click here to see an example of how to use list_audit_trails API.

list_available_audit_volumes(audit_profile_id, work_request_id, **kwargs)

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

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • work_request_id (str) – (required) The OCID of the work request.
  • trail_location (str) – (optional) The audit trail location.
  • month_in_consideration_greater_than (datetime) –

    (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 (datetime) –

    (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 (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AvailableAuditVolumeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_available_audit_volumes API.

list_collected_audit_volumes(audit_profile_id, work_request_id, **kwargs)

Gets a list of all collected audit volume data points.

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • work_request_id (str) – (required) The OCID of the work request.
  • month_in_consideration_greater_than (datetime) –

    (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 (datetime) –

    (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 (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CollectedAuditVolumeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_collected_audit_volumes API.

list_columns(target_database_id, **kwargs)

Returns a list of column metadata objects.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (list[str]) – (optional) A filter to return only items related to specific schema name.
  • table_name (list[str]) – (optional) A filter to return only items related to specific table name.
  • column_name (list[str]) – (optional) A filter to return only a specific column based on column name.
  • datatype (list[str]) – (optional) A filter to return only items related to specific datatype.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified.

    Allowed values are: “SCHEMANAME”, “TABLENAME”, “COLUMNNAME”, “DATATYPE”

  • schema_name_contains (str) – (optional) A filter to return only items if schema name contains a specific string.
  • table_name_contains (str) – (optional) A filter to return only items if table name contains a specific string.
  • column_name_contains (str) – (optional) A filter to return only items if column name contains a specific string.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of ColumnSummary

Return type:

Response

Example:

Click here to see an example of how to use list_columns API.

list_data_safe_private_endpoints(compartment_id, **kwargs)

Gets a list of Data Safe private endpoints.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • vcn_id (str) – (optional) A filter to return only resources that match the specified VCN OCID.
  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NA”

  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of DataSafePrivateEndpointSummary

Return type:

Response

Example:

Click here to see an example of how to use list_data_safe_private_endpoints API.

list_discovery_analytics(compartment_id, **kwargs)

Gets consolidated discovery analytics data based on the specified query parameters.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (optional) Attribute by which the discovery analytics data should be grouped.

    Allowed values are: “targetId”, “sensitiveDataModelId”

  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • sensitive_data_model_id (str) – (optional) A filter to return only the resources that match the specified sensitive data model OCID.
  • limit (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryAnalyticsCollection

Return type:

Response

Example:

Click here to see an example of how to use list_discovery_analytics API.

list_discovery_job_results(discovery_job_id, **kwargs)

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

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • discovery_type (str) –

    (optional) A filter to return only the resources that match the specified discovery type.

    Allowed values are: “ALL”, “NEW”, “MODIFIED”, “DELETED”

  • planned_action (str) –

    (optional) A filter to return only the resources that match the specified planned action.

    Allowed values are: “NONE”, “ACCEPT”, “INVALIDATE”, “REJECT”

  • is_result_applied (bool) – (optional) A filter to return the discovery result resources based on the value of their isResultApplied attribute.
  • schema_name (list[str]) – (optional) A filter to return only items related to specific schema name.
  • object_name (list[str]) – (optional) A filter to return only items related to a specific object name.
  • column_name (list[str]) – (optional) A filter to return only a specific column based on column name.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (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 (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryJobResultCollection

Return type:

Response

Example:

Click here to see an example of how to use list_discovery_job_results API.

list_discovery_jobs(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • discovery_job_id (str) – (optional) A filter to return only the resources that match the specified discovery job OCID.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • lifecycle_state (str) –

    (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 (str) – (optional) A filter to return only the resources that match the specified sensitive data model OCID.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending.

    Allowed values are: “timeStarted”, “displayName”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DiscoveryJobCollection

Return type:

Response

Example:

Click here to see an example of how to use list_discovery_jobs API.

list_findings(security_assessment_id, **kwargs)

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

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • severity (str) –

    (optional) A filter to return only findings of a particular risk level.

    Allowed values are: “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, “ADVISORY”, “PASS”

  • limit (int) –

    (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 (str) –

    (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 (bool) – (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 (str) –

    (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 (str) – (optional) Each finding has a key. This key is same for the finding across targets
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of FindingSummary

Return type:

Response

Example:

Click here to see an example of how to use list_findings API.

list_grants(user_assessment_id, user_key, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • user_key (str) – (required) The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user.
  • grant_key (str) – (optional) A filter to return only items that match the specified user grant key.
  • grant_name (str) – (optional) A filter to return only items that match the specified user grant name.
  • privilege_type (str) – (optional) A filter to return only items that match the specified privilege grant type.
  • privilege_category (str) – (optional) A filter to return only items that match the specified user privilege category.
  • depth_level (int) – (optional) A filter to return only items that match the specified user grant depth level.
  • depth_level_greater_than_or_equal_to (int) – (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 (int) – (optional) A filter to return only items that are at a level less than the specified user grant depth level.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of GrantSummary

Return type:

Response

Example:

Click here to see an example of how to use list_grants API.

list_library_masking_formats(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • library_masking_format_id (str) – (optional) A filter to return only the resources that match the specified library masking format OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type LibraryMaskingFormatCollection

Return type:

Response

Example:

Click here to see an example of how to use list_library_masking_formats API.

list_masked_columns(masking_report_id, **kwargs)

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

Parameters:
  • masking_report_id (str) – (required) The OCID of the masking report.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for all the fields is ascending.

    Allowed values are: “schemaName”, “objectName”

  • schema_name (list[str]) – (optional) A filter to return only items related to specific schema name.
  • object_name (list[str]) – (optional) A filter to return only items related to a specific object name.
  • column_name (list[str]) – (optional) A filter to return only a specific column based on column name.
  • object_type (list[str]) –

    (optional) A filter to return only items related to a specific object type.

    Allowed values are: “ALL”, “TABLE”, “EDITIONING_VIEW”

  • masking_column_group (list[str]) – (optional) A filter to return only the resources that match the specified masking column group.
  • sensitive_type_id (str) – (optional) A filter to return only items related to a specific sensitive type OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskedColumnCollection

Return type:

Response

Example:

Click here to see an example of how to use list_masked_columns API.

list_masking_analytics(compartment_id, **kwargs)

Gets consolidated masking analytics data based on the specified query parameters.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (optional) Attribute by which the masking analytics data should be grouped.

    Allowed values are: “targetId”, “policyId”

  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • masking_policy_id (str) – (optional) A filter to return only the resources that match the specified masking policy OCID.
  • limit (int) –

    (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingAnalyticsCollection

Return type:

Response

Example:

Click here to see an example of how to use list_masking_analytics API.

list_masking_columns(masking_policy_id, **kwargs)

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

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending.

    Allowed values are: “timeCreated”, “schemaName”, “objectName”

  • masking_column_lifecycle_state (str) –

    (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 (list[str]) –

    (optional) A filter to return only resources that match the specified data types.

    Allowed values are: “CHARACTER”, “DATE”, “LOB”, “NUMERIC”

  • schema_name (list[str]) – (optional) A filter to return only items related to specific schema name.
  • object_name (list[str]) – (optional) A filter to return only items related to a specific object name.
  • column_name (list[str]) – (optional) A filter to return only a specific column based on column name.
  • object_type (list[str]) –

    (optional) A filter to return only items related to a specific object type.

    Allowed values are: “ALL”, “TABLE”, “EDITIONING_VIEW”

  • masking_column_group (list[str]) – (optional) A filter to return only the resources that match the specified masking column group.
  • sensitive_type_id (str) – (optional) A filter to return only items related to a specific sensitive type OCID.
  • is_masking_enabled (bool) – (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 (bool) – (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) – (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 (datetime) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingColumnCollection

Return type:

Response

Example:

Click here to see an example of how to use list_masking_columns API.

list_masking_policies(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • masking_policy_id (str) – (optional) A filter to return only the resources that match the specified masking policy OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (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 (str) – (optional) A filter to return only the resources that match the specified sensitive data model OCID.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • time_created_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (bool) – (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 (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingPolicyCollection

Return type:

Response

Example:

Click here to see an example of how to use list_masking_policies API.

list_masking_reports(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • limit (int) –

    (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 (str) –

    (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 (str) – (optional) A filter to return only the resources that match the specified masking policy OCID.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeMaskingFinished is descending.

    Allowed values are: “timeMaskingFinished”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type MaskingReportCollection

Return type:

Response

Example:

Click here to see an example of how to use list_masking_reports API.

list_on_prem_connectors(compartment_id, **kwargs)

Gets a list of on-premises connectors.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • on_prem_connector_id (str) – (optional) A filter to return only the on-premises connector that matches the specified id.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • on_prem_connector_lifecycle_state (str) –

    (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”

  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of OnPremConnectorSummary

Return type:

Response

Example:

Click here to see an example of how to use list_on_prem_connectors API.

list_report_definitions(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) The name of the report definition to query.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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”, “DISPLAYORDER”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • is_seeded (bool) – (optional) A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
  • data_source (str) –

    (optional) Specifies the name of a resource that provides data for the report. For example alerts, events.

    Allowed values are: “EVENTS”, “ALERTS”

  • lifecycle_state (str) –

    (optional) An optional filter to return only resources that match the specified lifecycle state.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”

  • category (str) –

    (optional) An optional filter to return only resources that match the specified category.

    Allowed values are: “CUSTOM_REPORTS”, “SUMMARY”, “ACTIVITY_AUDITING”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ReportDefinitionCollection

Return type:

Response

Example:

Click here to see an example of how to use list_report_definitions API.

list_reports(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) The name of the report definition to query.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The ID of the report definition to filter the list of reports
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • lifecycle_state (str) –

    (optional) An optional filter to return only resources that match the specified lifecycle state.

    Allowed values are: “UPDATING”, “ACTIVE”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ReportCollection

Return type:

Response

Example:

Click here to see an example of how to use list_reports API.

list_roles(target_database_id, **kwargs)

Returns a list of role metadata objects.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (list[str]) – (optional) A filter to return only a specific role based on role name.
  • is_oracle_maintained (bool) – (optional) A filter to return roles based on whether they are maintained by oracle or not.
  • authentication_type (str) – (optional) A filter to return roles based on authentication type.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified.

    Allowed values are: “ROLENAME”

  • role_name_contains (str) – (optional) A filter to return only items if role name contains a specific string.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of RoleSummary

Return type:

Response

Example:

Click here to see an example of how to use list_roles API.

list_schemas(target_database_id, **kwargs)

Returns list of schema.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (list[str]) – (optional) A filter to return only items related to specific schema name.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified.

    Allowed values are: “SCHEMANAME”

  • is_oracle_maintained (bool) – (optional) A filter to return only items related to specific type of schema.
  • schema_name_contains (str) – (optional) A filter to return only items if schema name contains a specific string.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of SchemaSummary

Return type:

Response

Example:

Click here to see an example of how to use list_schemas API.

list_security_assessments(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • type (str) –

    (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 (str) – (optional) The OCID of the security assessment of type SAVE_SCHEDULE.
  • is_schedule_assessment (bool) – (optional) A filter to return only security assessments of type save schedule.
  • triggered_by (str) –

    (optional) A filter to return only security asessments that were created by either user or system.

    Allowed values are: “USER”, “SYSTEM”

  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • is_baseline (bool) – (optional) A filter to return only security assessments that are set as baseline.
  • sort_by (str) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of SecurityAssessmentSummary

Return type:

Response

Example:

Click here to see an example of how to use list_security_assessments API.

list_sensitive_columns(sensitive_data_model_id, **kwargs)

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

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • time_created_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (datetime) – (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 (datetime) – (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 (str) –

    (optional) Filters the sensitive column resources with the given lifecycle state values.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”

  • schema_name (list[str]) – (optional) A filter to return only items related to specific schema name.
  • object_name (list[str]) – (optional) A filter to return only items related to a specific object name.
  • column_name (list[str]) – (optional) A filter to return only a specific column based on column name.
  • object_type (list[str]) –

    (optional) A filter to return only items related to a specific object type.

    Allowed values are: “ALL”, “TABLE”, “EDITIONING_VIEW”

  • data_type (list[str]) – (optional) A filter to return only the resources that match the specified data types.
  • status (list[str]) –

    (optional) A filter to return only the sensitive columns that match the specified status.

    Allowed values are: “VALID”, “INVALID”

  • sensitive_type_id (list[str]) – (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 (list[str]) – (optional) A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys.
  • relation_type (list[str]) –

    (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 (str) – (optional) A filter to return only the sensitive columns that belong to the specified column group.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (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”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveColumnCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sensitive_columns API.

list_sensitive_data_models(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • sensitive_data_model_id (str) – (optional) A filter to return only the resources that match the specified sensitive data model OCID.
  • time_created_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (str) – (optional) A filter to return only items related to a specific target OCID.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) A filter to return only the resources that match the specified lifecycle state.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveDataModelCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sensitive_data_models API.

list_sensitive_types(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • sensitive_type_id (str) – (optional) A filter to return only items related to a specific sensitive type OCID.
  • sensitive_type_source (str) –

    (optional) A filter to return the sensitive type resources based on the value of their source attribute.

    Allowed values are: “ORACLE”, “USER”

  • entity_type (str) –

    (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 (str) – (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 (str) – (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 (datetime) –

    (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 (datetime) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (optional) A filter to return only the resources that match the specified lifecycle state.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SensitiveTypeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sensitive_types API.

list_tables(target_database_id, **kwargs)

Returns a list of table metadata objects.

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) –

    (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 (str) –

    (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 (list[str]) – (optional) A filter to return only items related to specific schema name.
  • table_name (list[str]) – (optional) A filter to return only items related to specific table name.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified.

    Allowed values are: “SCHEMANAME”, “TABLENAME”

  • table_name_contains (str) – (optional) A filter to return only items if table name contains a specific string.
  • schema_name_contains (str) – (optional) A filter to return only items if schema name contains a specific string.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of TableSummary

Return type:

Response

Example:

Click here to see an example of how to use list_tables API.

list_target_alert_policy_associations(compartment_id, **kwargs)

Gets a list of all target-alert policy associations.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • target_alert_policy_association_id (str) – (optional) A filter to return only items related to a specific target-alert policy association ID.
  • alert_policy_id (str) – (optional) A filter to return policy by it’s OCID.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • lifecycle_state (str) –

    (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 (int) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • time_created_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (bool) – (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 (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TargetAlertPolicyAssociationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_target_alert_policy_associations API.

list_target_databases(compartment_id, **kwargs)

Returns the list of registered target databases in Data Safe.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • associated_resource_id (str) – (optional) A filter to return the target databases that are associated to the resource id passed in as a parameter value.
  • target_database_id (str) – (optional) A filter to return the target database that matches the specified OCID.
  • display_name (str) – (optional) A filter to return only resources that match the specified display name.
  • lifecycle_state (str) –

    (optional) A filter to return the target databases that matches the current state of the target database.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “FAILED”

  • database_type (str) –

    (optional) A filter to return target databases that match the database type of the target database.

    Allowed values are: “DATABASE_CLOUD_SERVICE”, “AUTONOMOUS_DATABASE”, “INSTALLED_DATABASE”

  • infrastructure_type (str) –

    (optional) A filter to return target databases that match the infrastructure type of the target database.

    Allowed values are: “ORACLE_CLOUD”, “CLOUD_AT_CUSTOMER”, “ON_PREMISES”, “NON_ORACLE_CLOUD”

  • limit (int) –

    (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 (str) –

    (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 (bool) – (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of TargetDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_target_databases API.

list_user_analytics(user_assessment_id, **kwargs)

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

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (int) –

    (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 (str) – (optional) A filter to return only items that match the specified user category.
  • user_key (str) – (optional) A filter to return only items that match the specified user key.
  • account_status (str) – (optional) A filter to return only items that match the specified account status.
  • authentication_type (str) – (optional) A filter to return only items that match the specified authentication type.
  • user_name (str) – (optional) A filter to return only items that match the specified user name.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • time_last_login_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of UserAggregation

Return type:

Response

Example:

Click here to see an example of how to use list_user_analytics API.

list_user_assessments(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • compartment_id_in_subtree (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only resources that match the specified display name.
  • schedule_user_assessment_id (str) – (optional) The OCID of the user assessment of type SAVE_SCHEDULE.
  • is_schedule_assessment (bool) – (optional) A filter to return only user assessments of type SAVE_SCHEDULE.
  • is_baseline (bool) – (optional) A filter to return only user assessments that are set as baseline.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • type (str) –

    (optional) A filter to return only items that match the specified assessment type.

    Allowed values are: “LATEST”, “SAVED”, “COMPARTMENT”, “SAVE_SCHEDULE”

  • triggered_by (str) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (int) –

    (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 (str) –

    (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 (str) –

    (optional) The current state of the user assessment.

    Allowed values are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “FAILED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of UserAssessmentSummary

Return type:

Response

Example:

Click here to see an example of how to use list_user_assessments API.

list_users(user_assessment_id, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • limit (int) –

    (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 (bool) – (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 (str) –

    (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 (str) – (optional) A filter to return only items that match the specified user category.
  • user_key (str) – (optional) A filter to return only items that match the specified user key.
  • account_status (str) – (optional) A filter to return only items that match the specified account status.
  • authentication_type (str) – (optional) A filter to return only items that match the specified authentication type.
  • user_name (str) – (optional) A filter to return only items that match the specified user name.
  • target_id (str) – (optional) A filter to return only items related to a specific target OCID.
  • time_last_login_greater_than_or_equal_to (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (datetime) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of UserSummary

Return type:

Response

Example:

Click here to see an example of how to use list_users API.

list_work_request_errors(work_request_id, **kwargs)

Gets a list of errors for the specified work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (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 (int) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (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 (int) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)

Gets a list of work requests.

Parameters:
  • compartment_id (str) – (required) A filter to return only resources that match the specified compartment OCID.
  • operation_type (str) – (optional) A filter to return only work requests that match the specific operation type.
  • sort_by (str) –

    (optional) The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for STARTTIME and FINISHTIME is descending.

    Allowed values are: “STARTTIME”, “FINISHTIME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • resource_id (str) – (optional) A filter to return only work requests that match the specified resource OCID.
  • target_database_id (str) – (optional) A filter to return only work requests that are associated to the specified target database OCID.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • page (str) –

    (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 (int) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

mask_data(masking_policy_id, mask_data_details, **kwargs)

Masks data using the specified masking policy.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • mask_data_details (oci.data_safe.models.MaskDataDetails) – (required) Details to mask data.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use mask_data API.

modify_global_settings(modify_global_settings_details, compartment_id, **kwargs)

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

Parameters:
  • modify_global_settings_details (oci.data_safe.models.ModifyGlobalSettingsDetails) – (required) The details used to update global settings in Data Safe.
  • compartment_id (str) – (required) The OCID of the compartment.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use modify_global_settings API.

patch_alerts(patch_alerts_details, **kwargs)

Patch alerts. Updates one or more alerts by specifying alert Ids.

Parameters:
  • patch_alerts_details (oci.data_safe.models.PatchAlertsDetails) – (required) Details to patch alerts.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use patch_alerts API.

patch_discovery_job_results(discovery_job_id, patch_discovery_job_result_details, **kwargs)

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.

Parameters:
  • discovery_job_id (str) – (required) The OCID of the discovery job.
  • patch_discovery_job_result_details (oci.data_safe.models.PatchDiscoveryJobResultDetails) – (required) Details to patch discovery results.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use patch_discovery_job_results API.

patch_masking_columns(masking_policy_id, patch_masking_columns_details, **kwargs)

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.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • patch_masking_columns_details (oci.data_safe.models.PatchMaskingColumnsDetails) – (required) Details to patch masking columns.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use patch_masking_columns API.

patch_sensitive_columns(sensitive_data_model_id, patch_sensitive_column_details, **kwargs)

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.

Parameters:
  • sensitive_data_model_id (str) – (required) The OCID of the sensitive data model.
  • patch_sensitive_column_details (oci.data_safe.models.PatchSensitiveColumnDetails) – (required) Details to patch sensitive columns.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use patch_sensitive_columns API.

provision_audit_policy(provision_audit_policy_details, audit_policy_id, **kwargs)

Provision audit policy.

Parameters:
  • provision_audit_policy_details (oci.data_safe.models.ProvisionAuditPolicyDetails) – (required) Details for provisioning the given policies on the source target database.
  • audit_policy_id (str) – (required) Unique audit policy identifier.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use provision_audit_policy API.

refresh_security_assessment(security_assessment_id, run_security_assessment_details, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • run_security_assessment_details (oci.data_safe.models.RunSecurityAssessmentDetails) – (required) Details to create an on-demand saved security assessment.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use refresh_security_assessment API.

refresh_user_assessment(user_assessment_id, run_user_assessment_details, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • run_user_assessment_details (oci.data_safe.models.RunUserAssessmentDetails) – (required) The details required to create an on-demand saved user assessment.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use refresh_user_assessment API.

resume_audit_trail(audit_trail_id, **kwargs)

Resumes the specified audit trail once it got stopped.

Parameters:
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use resume_audit_trail API.

resume_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use resume_work_request API.

retrieve_audit_policies(audit_policy_id, **kwargs)

Retrieves the audit policy details from the source target database.

Parameters:
  • audit_policy_id (str) – (required) Unique audit policy identifier.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use retrieve_audit_policies API.

set_security_assessment_baseline(security_assessment_id, **kwargs)

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

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • base_line_details (oci.data_safe.models.SecurityAssessmentBaseLineDetails) – (optional) Details of security assessment that need to be updated while setting the baseline.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use set_security_assessment_baseline API.

set_user_assessment_baseline(user_assessment_id, **kwargs)

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

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • base_line_details (oci.data_safe.models.UserAssessmentBaseLineDetails) – (optional) Details of user assessment that need to be updated while setting the baseline.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use set_user_assessment_baseline API.

start_audit_trail(start_audit_trail_details, audit_trail_id, **kwargs)

Starts collection of audit records on the specified audit trail.

Parameters:
  • start_audit_trail_details (oci.data_safe.models.StartAuditTrailDetails) – (required) Details for the starting audit.
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use start_audit_trail API.

stop_audit_trail(audit_trail_id, **kwargs)

Stops the specified audit trail.

Parameters:
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use stop_audit_trail API.

suspend_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use suspend_work_request API.

unset_security_assessment_baseline(security_assessment_id, **kwargs)

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.

Parameters:
  • security_assessment_id (str) – (required) The OCID of the security assessment.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use unset_security_assessment_baseline API.

unset_user_assessment_baseline(user_assessment_id, **kwargs)

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.

Parameters:
  • user_assessment_id (str) – (required) The OCID of the user assessment.
  • if_match (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use unset_user_assessment_baseline API.

update_alert(alert_id, update_alert_details, **kwargs)

Updates alert status of the specified alert.

Parameters:
  • alert_id (str) – (required) The OCID of alert.
  • update_alert_details (oci.data_safe.models.UpdateAlertDetails) – (required) The details used to update alert status.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Alert

Return type:

Response

Example:

Click here to see an example of how to use update_alert API.

update_audit_archive_retrieval(audit_archive_retrieval_id, update_audit_archive_retrieval_details, **kwargs)

Updates the audit archive retrieval.

Parameters:
  • audit_archive_retrieval_id (str) – (required) OCID of the archive retrieval.
  • update_audit_archive_retrieval_details (oci.data_safe.models.UpdateAuditArchiveRetrievalDetails) – (required) Details to update the audit archive retrieval.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_audit_archive_retrieval API.

update_audit_policy(audit_policy_id, update_audit_policy_details, **kwargs)

Updates the audit policy.

Parameters:
  • audit_policy_id (str) – (required) Unique audit policy identifier.
  • update_audit_policy_details (oci.data_safe.models.UpdateAuditPolicyDetails) – (required) Details to update the audit policy.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_audit_policy API.

update_audit_profile(audit_profile_id, update_audit_profile_details, **kwargs)

Updates one or more attributes of the specified audit profile.

Parameters:
  • audit_profile_id (str) – (required) The OCID of the audit.
  • update_audit_profile_details (oci.data_safe.models.UpdateAuditProfileDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_audit_profile API.

update_audit_trail(audit_trail_id, update_audit_trail_details, **kwargs)

Updates one or more attributes of the specified audit trail.

Parameters:
  • audit_trail_id (str) – (required) The OCID of the audit trail.
  • update_audit_trail_details (oci.data_safe.models.UpdateAuditTrailDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_audit_trail API.

update_data_safe_private_endpoint(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, **kwargs)

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

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • update_data_safe_private_endpoint_details (oci.data_safe.models.UpdateDataSafePrivateEndpointDetails) – (required) The details used to update a Data Safe private endpoint.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_data_safe_private_endpoint API.

update_library_masking_format(library_masking_format_id, update_library_masking_format_details, **kwargs)

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.

Parameters:
  • library_masking_format_id (str) – (required) The OCID of the library masking format.
  • update_library_masking_format_details (oci.data_safe.models.UpdateLibraryMaskingFormatDetails) – (required) Details to update a library masking format.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_library_masking_format API.

update_masking_column(masking_column_key, masking_policy_id, update_masking_column_details, **kwargs)

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.

Parameters:
  • masking_column_key (str) – (required) The unique key that identifies the masking column. It’s numeric and unique within a masking policy.
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • update_masking_column_details (oci.data_safe.models.UpdateMaskingColumnDetails) – (required) Details to update a masking column.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_masking_column API.

update_masking_policy(masking_policy_id, update_masking_policy_details, **kwargs)

Updates one or more attributes of the specified masking policy.

Parameters:
  • masking_policy_id (str) – (required) The OCID of the masking policy.
  • update_masking_policy_details (oci.data_safe.models.UpdateMaskingPolicyDetails) – (required) Details to update a masking policy.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_masking_policy API.

update_on_prem_connector(on_prem_connector_id, update_on_prem_connector_details, **kwargs)

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

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • update_on_prem_connector_details (oci.data_safe.models.UpdateOnPremConnectorDetails) – (required) The details used to update a on-premises connector.
  • if_match (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_on_prem_connector API.

update_on_prem_connector_wallet(update_on_prem_connector_wallet_details, on_prem_connector_id, **kwargs)

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

Parameters:
  • update_on_prem_connector_wallet_details (oci.data_safe.models.UpdateOnPremConnectorWalletDetails) – (required) The details used to update an on-premises connector’s wallet.
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • opc_retry_token (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation e