data-safe
=============

Description
-----------
CLI for using Oracle Data Safe.

Available Commands
------------------
* :doc:`alert </cmdref/data-safe/alert>`

  * :doc:`change-compartment </cmdref/data-safe/alert/change-compartment>`
  * :doc:`get </cmdref/data-safe/alert/get>`
  * :doc:`patch </cmdref/data-safe/alert/patch>`
  * :doc:`update </cmdref/data-safe/alert/update>`

* :doc:`alert-policy </cmdref/data-safe/alert-policy>`

  * :doc:`get </cmdref/data-safe/alert-policy/get>`
  * :doc:`list </cmdref/data-safe/alert-policy/list>`
  * :doc:`list-alert-policy-rules </cmdref/data-safe/alert-policy/list-alert-policy-rules>`

* :doc:`alert-summary </cmdref/data-safe/alert-summary>`

  * :doc:`list-alert-analytics </cmdref/data-safe/alert-summary/list-alert-analytics>`
  * :doc:`list-alerts </cmdref/data-safe/alert-summary/list-alerts>`

* :doc:`audit-archive-retrieval </cmdref/data-safe/audit-archive-retrieval>`

  * :doc:`change-compartment </cmdref/data-safe/audit-archive-retrieval/change-compartment>`
  * :doc:`create </cmdref/data-safe/audit-archive-retrieval/create>`
  * :doc:`delete </cmdref/data-safe/audit-archive-retrieval/delete>`
  * :doc:`get </cmdref/data-safe/audit-archive-retrieval/get>`
  * :doc:`list </cmdref/data-safe/audit-archive-retrieval/list>`
  * :doc:`update </cmdref/data-safe/audit-archive-retrieval/update>`

* :doc:`audit-event-summary </cmdref/data-safe/audit-event-summary>`

  * :doc:`list-audit-event-analytics </cmdref/data-safe/audit-event-summary/list-audit-event-analytics>`
  * :doc:`list-audit-events </cmdref/data-safe/audit-event-summary/list-audit-events>`

* :doc:`audit-policy </cmdref/data-safe/audit-policy>`

  * :doc:`change-compartment </cmdref/data-safe/audit-policy/change-compartment>`
  * :doc:`get </cmdref/data-safe/audit-policy/get>`
  * :doc:`provision </cmdref/data-safe/audit-policy/provision>`
  * :doc:`retrieve </cmdref/data-safe/audit-policy/retrieve>`
  * :doc:`update </cmdref/data-safe/audit-policy/update>`

* :doc:`audit-policy-collection </cmdref/data-safe/audit-policy-collection>`

  * :doc:`list-audit-policies </cmdref/data-safe/audit-policy-collection/list-audit-policies>`

* :doc:`audit-profile </cmdref/data-safe/audit-profile>`

  * :doc:`calculate-audit-volume-available </cmdref/data-safe/audit-profile/calculate-audit-volume-available>`
  * :doc:`calculate-audit-volume-collected </cmdref/data-safe/audit-profile/calculate-audit-volume-collected>`
  * :doc:`change-compartment </cmdref/data-safe/audit-profile/change-compartment>`
  * :doc:`change-retention </cmdref/data-safe/audit-profile/change-retention>`
  * :doc:`discover-audit-trails </cmdref/data-safe/audit-profile/discover-audit-trails>`
  * :doc:`get </cmdref/data-safe/audit-profile/get>`
  * :doc:`list </cmdref/data-safe/audit-profile/list>`
  * :doc:`list-available-audit-volumes </cmdref/data-safe/audit-profile/list-available-audit-volumes>`
  * :doc:`list-collected-audit-volumes </cmdref/data-safe/audit-profile/list-collected-audit-volumes>`
  * :doc:`update </cmdref/data-safe/audit-profile/update>`

* :doc:`audit-profile-analytic-collection </cmdref/data-safe/audit-profile-analytic-collection>`

  * :doc:`list-audit-profile-analytics </cmdref/data-safe/audit-profile-analytic-collection/list-audit-profile-analytics>`

* :doc:`audit-trail </cmdref/data-safe/audit-trail>`

  * :doc:`delete </cmdref/data-safe/audit-trail/delete>`
  * :doc:`get </cmdref/data-safe/audit-trail/get>`
  * :doc:`list </cmdref/data-safe/audit-trail/list>`
  * :doc:`resume </cmdref/data-safe/audit-trail/resume>`
  * :doc:`start </cmdref/data-safe/audit-trail/start>`
  * :doc:`stop </cmdref/data-safe/audit-trail/stop>`
  * :doc:`update </cmdref/data-safe/audit-trail/update>`

* :doc:`audit-trail-analytic-collection </cmdref/data-safe/audit-trail-analytic-collection>`

  * :doc:`list-audit-trail-analytics </cmdref/data-safe/audit-trail-analytic-collection/list-audit-trail-analytics>`

* :doc:`discovery-job </cmdref/data-safe/discovery-job>`

  * :doc:`change-compartment </cmdref/data-safe/discovery-job/change-compartment>`
  * :doc:`create </cmdref/data-safe/discovery-job/create>`
  * :doc:`delete </cmdref/data-safe/discovery-job/delete>`
  * :doc:`get </cmdref/data-safe/discovery-job/get>`
  * :doc:`list </cmdref/data-safe/discovery-job/list>`
  * :doc:`list-discovery-job-results </cmdref/data-safe/discovery-job/list-discovery-job-results>`
  * :doc:`patch-discovery-job-results </cmdref/data-safe/discovery-job/patch-discovery-job-results>`

* :doc:`discovery-job-result </cmdref/data-safe/discovery-job-result>`

  * :doc:`delete </cmdref/data-safe/discovery-job-result/delete>`
  * :doc:`get </cmdref/data-safe/discovery-job-result/get>`

* :doc:`library-masking-format </cmdref/data-safe/library-masking-format>`

  * :doc:`change-compartment </cmdref/data-safe/library-masking-format/change-compartment>`
  * :doc:`create </cmdref/data-safe/library-masking-format/create>`
  * :doc:`delete </cmdref/data-safe/library-masking-format/delete>`
  * :doc:`get </cmdref/data-safe/library-masking-format/get>`
  * :doc:`update </cmdref/data-safe/library-masking-format/update>`

* :doc:`library-masking-format-summary </cmdref/data-safe/library-masking-format-summary>`

  * :doc:`list-library-masking-formats </cmdref/data-safe/library-masking-format-summary/list-library-masking-formats>`

* :doc:`masked-column-summary </cmdref/data-safe/masked-column-summary>`

  * :doc:`list-masked-columns </cmdref/data-safe/masked-column-summary/list-masked-columns>`

* :doc:`masking-column </cmdref/data-safe/masking-column>`

  * :doc:`create </cmdref/data-safe/masking-column/create>`
  * :doc:`delete </cmdref/data-safe/masking-column/delete>`
  * :doc:`get </cmdref/data-safe/masking-column/get>`
  * :doc:`get-compatible-formats-for-data-types </cmdref/data-safe/masking-column/get-compatible-formats-for-data-types>`
  * :doc:`get-compatible-formats-for-sensitive-types </cmdref/data-safe/masking-column/get-compatible-formats-for-sensitive-types>`
  * :doc:`list </cmdref/data-safe/masking-column/list>`
  * :doc:`patch </cmdref/data-safe/masking-column/patch>`
  * :doc:`update </cmdref/data-safe/masking-column/update>`

* :doc:`masking-policy </cmdref/data-safe/masking-policy>`

  * :doc:`add </cmdref/data-safe/masking-policy/add>`
  * :doc:`change-compartment </cmdref/data-safe/masking-policy/change-compartment>`
  * :doc:`create </cmdref/data-safe/masking-policy/create>`
  * :doc:`create-masking-policy-create-column-source-from-sdm-details </cmdref/data-safe/masking-policy/create-masking-policy-create-column-source-from-sdm-details>`
  * :doc:`create-masking-policy-create-column-source-from-target-details </cmdref/data-safe/masking-policy/create-masking-policy-create-column-source-from-target-details>`
  * :doc:`delete </cmdref/data-safe/masking-policy/delete>`
  * :doc:`download </cmdref/data-safe/masking-policy/download>`
  * :doc:`download-masking-log </cmdref/data-safe/masking-policy/download-masking-log>`
  * :doc:`download-masking-report </cmdref/data-safe/masking-policy/download-masking-report>`
  * :doc:`generate-masking-policy-for-download </cmdref/data-safe/masking-policy/generate-masking-policy-for-download>`
  * :doc:`generate-masking-report-for-download </cmdref/data-safe/masking-policy/generate-masking-report-for-download>`
  * :doc:`get </cmdref/data-safe/masking-policy/get>`
  * :doc:`list </cmdref/data-safe/masking-policy/list>`
  * :doc:`list-masking-analytics </cmdref/data-safe/masking-policy/list-masking-analytics>`
  * :doc:`list-masking-reports </cmdref/data-safe/masking-policy/list-masking-reports>`
  * :doc:`mask-data </cmdref/data-safe/masking-policy/mask-data>`
  * :doc:`update </cmdref/data-safe/masking-policy/update>`
  * :doc:`update-masking-policy-update-column-source-sdm-details </cmdref/data-safe/masking-policy/update-masking-policy-update-column-source-sdm-details>`
  * :doc:`update-masking-policy-update-column-source-target-details </cmdref/data-safe/masking-policy/update-masking-policy-update-column-source-target-details>`
  * :doc:`upload </cmdref/data-safe/masking-policy/upload>`

* :doc:`masking-report </cmdref/data-safe/masking-report>`

  * :doc:`get </cmdref/data-safe/masking-report/get>`

* :doc:`on-prem-connector </cmdref/data-safe/on-prem-connector>`

  * :doc:`change-compartment </cmdref/data-safe/on-prem-connector/change-compartment>`
  * :doc:`create </cmdref/data-safe/on-prem-connector/create>`
  * :doc:`delete </cmdref/data-safe/on-prem-connector/delete>`
  * :doc:`generate-on-prem-connector-configuration </cmdref/data-safe/on-prem-connector/generate-on-prem-connector-configuration>`
  * :doc:`get </cmdref/data-safe/on-prem-connector/get>`
  * :doc:`list </cmdref/data-safe/on-prem-connector/list>`
  * :doc:`update </cmdref/data-safe/on-prem-connector/update>`
  * :doc:`update-on-prem-connector-wallet </cmdref/data-safe/on-prem-connector/update-on-prem-connector-wallet>`

* :doc:`private-endpoint </cmdref/data-safe/private-endpoint>`

  * :doc:`change-compartment </cmdref/data-safe/private-endpoint/change-compartment>`
  * :doc:`create </cmdref/data-safe/private-endpoint/create>`
  * :doc:`delete </cmdref/data-safe/private-endpoint/delete>`
  * :doc:`get </cmdref/data-safe/private-endpoint/get>`
  * :doc:`list </cmdref/data-safe/private-endpoint/list>`
  * :doc:`update </cmdref/data-safe/private-endpoint/update>`

* :doc:`report </cmdref/data-safe/report>`

  * :doc:`change-compartment </cmdref/data-safe/report/change-compartment>`
  * :doc:`get </cmdref/data-safe/report/get>`
  * :doc:`get-report-content </cmdref/data-safe/report/get-report-content>`

* :doc:`report-definition </cmdref/data-safe/report-definition>`

  * :doc:`change-compartment </cmdref/data-safe/report-definition/change-compartment>`
  * :doc:`create </cmdref/data-safe/report-definition/create>`
  * :doc:`delete </cmdref/data-safe/report-definition/delete>`
  * :doc:`generate-report </cmdref/data-safe/report-definition/generate-report>`
  * :doc:`get </cmdref/data-safe/report-definition/get>`
  * :doc:`list </cmdref/data-safe/report-definition/list>`
  * :doc:`update </cmdref/data-safe/report-definition/update>`

* :doc:`report-summary </cmdref/data-safe/report-summary>`

  * :doc:`list-reports </cmdref/data-safe/report-summary/list-reports>`

* :doc:`security-assessment </cmdref/data-safe/security-assessment>`

  * :doc:`change-compartment </cmdref/data-safe/security-assessment/change-compartment>`
  * :doc:`compare </cmdref/data-safe/security-assessment/compare>`
  * :doc:`create </cmdref/data-safe/security-assessment/create>`
  * :doc:`delete </cmdref/data-safe/security-assessment/delete>`
  * :doc:`download-security-assessment-report </cmdref/data-safe/security-assessment/download-security-assessment-report>`
  * :doc:`generate-security-assessment-report </cmdref/data-safe/security-assessment/generate-security-assessment-report>`
  * :doc:`get </cmdref/data-safe/security-assessment/get>`
  * :doc:`get-security-assessment-comparison </cmdref/data-safe/security-assessment/get-security-assessment-comparison>`
  * :doc:`list </cmdref/data-safe/security-assessment/list>`
  * :doc:`list-findings </cmdref/data-safe/security-assessment/list-findings>`
  * :doc:`refresh </cmdref/data-safe/security-assessment/refresh>`
  * :doc:`set-security-assessment-baseline </cmdref/data-safe/security-assessment/set-security-assessment-baseline>`
  * :doc:`unset-security-assessment-baseline </cmdref/data-safe/security-assessment/unset-security-assessment-baseline>`
  * :doc:`update </cmdref/data-safe/security-assessment/update>`

* :doc:`sensitive-column </cmdref/data-safe/sensitive-column>`

  * :doc:`create </cmdref/data-safe/sensitive-column/create>`
  * :doc:`delete </cmdref/data-safe/sensitive-column/delete>`
  * :doc:`get </cmdref/data-safe/sensitive-column/get>`
  * :doc:`list </cmdref/data-safe/sensitive-column/list>`
  * :doc:`patch </cmdref/data-safe/sensitive-column/patch>`
  * :doc:`update </cmdref/data-safe/sensitive-column/update>`

* :doc:`sensitive-data-model </cmdref/data-safe/sensitive-data-model>`

  * :doc:`apply-discovery-job-results </cmdref/data-safe/sensitive-data-model/apply-discovery-job-results>`
  * :doc:`change-compartment </cmdref/data-safe/sensitive-data-model/change-compartment>`
  * :doc:`create </cmdref/data-safe/sensitive-data-model/create>`
  * :doc:`delete </cmdref/data-safe/sensitive-data-model/delete>`
  * :doc:`download </cmdref/data-safe/sensitive-data-model/download>`
  * :doc:`download-discovery-report </cmdref/data-safe/sensitive-data-model/download-discovery-report>`
  * :doc:`generate-discovery-report-for-download </cmdref/data-safe/sensitive-data-model/generate-discovery-report-for-download>`
  * :doc:`generate-sensitive-data-model-for-download </cmdref/data-safe/sensitive-data-model/generate-sensitive-data-model-for-download>`
  * :doc:`get </cmdref/data-safe/sensitive-data-model/get>`
  * :doc:`list </cmdref/data-safe/sensitive-data-model/list>`
  * :doc:`list-discovery-analytics </cmdref/data-safe/sensitive-data-model/list-discovery-analytics>`
  * :doc:`update </cmdref/data-safe/sensitive-data-model/update>`
  * :doc:`upload </cmdref/data-safe/sensitive-data-model/upload>`

* :doc:`sensitive-type </cmdref/data-safe/sensitive-type>`

  * :doc:`change-compartment </cmdref/data-safe/sensitive-type/change-compartment>`
  * :doc:`create </cmdref/data-safe/sensitive-type/create>`
  * :doc:`create-sensitive-type-create-sensitive-category-details </cmdref/data-safe/sensitive-type/create-sensitive-type-create-sensitive-category-details>`
  * :doc:`create-sensitive-type-create-sensitive-type-pattern-details </cmdref/data-safe/sensitive-type/create-sensitive-type-create-sensitive-type-pattern-details>`
  * :doc:`delete </cmdref/data-safe/sensitive-type/delete>`
  * :doc:`get </cmdref/data-safe/sensitive-type/get>`
  * :doc:`list </cmdref/data-safe/sensitive-type/list>`
  * :doc:`update </cmdref/data-safe/sensitive-type/update>`
  * :doc:`update-sensitive-type-update-sensitive-category-details </cmdref/data-safe/sensitive-type/update-sensitive-type-update-sensitive-category-details>`
  * :doc:`update-sensitive-type-update-sensitive-type-pattern-details </cmdref/data-safe/sensitive-type/update-sensitive-type-update-sensitive-type-pattern-details>`

* :doc:`service </cmdref/data-safe/service>`

  * :doc:`enable </cmdref/data-safe/service/enable>`
  * :doc:`get </cmdref/data-safe/service/get>`
  * :doc:`modify-global-settings </cmdref/data-safe/service/modify-global-settings>`

* :doc:`target-alert-policy-association </cmdref/data-safe/target-alert-policy-association>`

  * :doc:`change-compartment </cmdref/data-safe/target-alert-policy-association/change-compartment>`
  * :doc:`create </cmdref/data-safe/target-alert-policy-association/create>`
  * :doc:`delete </cmdref/data-safe/target-alert-policy-association/delete>`
  * :doc:`get </cmdref/data-safe/target-alert-policy-association/get>`
  * :doc:`update </cmdref/data-safe/target-alert-policy-association/update>`

* :doc:`target-alert-policy-association-summary </cmdref/data-safe/target-alert-policy-association-summary>`

  * :doc:`list-target-alert-policy-associations </cmdref/data-safe/target-alert-policy-association-summary/list-target-alert-policy-associations>`

* :doc:`target-database </cmdref/data-safe/target-database>`

  * :doc:`activate </cmdref/data-safe/target-database/activate>`
  * :doc:`change-compartment </cmdref/data-safe/target-database/change-compartment>`
  * :doc:`create </cmdref/data-safe/target-database/create>`
  * :doc:`deactivate </cmdref/data-safe/target-database/deactivate>`
  * :doc:`delete </cmdref/data-safe/target-database/delete>`
  * :doc:`download-privilege-script </cmdref/data-safe/target-database/download-privilege-script>`
  * :doc:`get </cmdref/data-safe/target-database/get>`
  * :doc:`list </cmdref/data-safe/target-database/list>`
  * :doc:`list-columns </cmdref/data-safe/target-database/list-columns>`
  * :doc:`list-roles </cmdref/data-safe/target-database/list-roles>`
  * :doc:`list-schemas </cmdref/data-safe/target-database/list-schemas>`
  * :doc:`list-tables </cmdref/data-safe/target-database/list-tables>`
  * :doc:`update </cmdref/data-safe/target-database/update>`

* :doc:`user-assessment </cmdref/data-safe/user-assessment>`

  * :doc:`change-compartment </cmdref/data-safe/user-assessment/change-compartment>`
  * :doc:`compare </cmdref/data-safe/user-assessment/compare>`
  * :doc:`create </cmdref/data-safe/user-assessment/create>`
  * :doc:`delete </cmdref/data-safe/user-assessment/delete>`
  * :doc:`download-user-assessment-report </cmdref/data-safe/user-assessment/download-user-assessment-report>`
  * :doc:`generate-user-assessment-report </cmdref/data-safe/user-assessment/generate-user-assessment-report>`
  * :doc:`get </cmdref/data-safe/user-assessment/get>`
  * :doc:`get-user-assessment-comparison </cmdref/data-safe/user-assessment/get-user-assessment-comparison>`
  * :doc:`list </cmdref/data-safe/user-assessment/list>`
  * :doc:`list-grants </cmdref/data-safe/user-assessment/list-grants>`
  * :doc:`list-user-analytics </cmdref/data-safe/user-assessment/list-user-analytics>`
  * :doc:`list-users </cmdref/data-safe/user-assessment/list-users>`
  * :doc:`refresh </cmdref/data-safe/user-assessment/refresh>`
  * :doc:`set-user-assessment-baseline </cmdref/data-safe/user-assessment/set-user-assessment-baseline>`
  * :doc:`unset-user-assessment-baseline </cmdref/data-safe/user-assessment/unset-user-assessment-baseline>`
  * :doc:`update </cmdref/data-safe/user-assessment/update>`

* :doc:`work-request </cmdref/data-safe/work-request>`

  * :doc:`cancel </cmdref/data-safe/work-request/cancel>`
  * :doc:`get </cmdref/data-safe/work-request/get>`
  * :doc:`list </cmdref/data-safe/work-request/list>`
  * :doc:`resume </cmdref/data-safe/work-request/resume>`
  * :doc:`suspend </cmdref/data-safe/work-request/suspend>`

* :doc:`work-request-error </cmdref/data-safe/work-request-error>`

  * :doc:`list </cmdref/data-safe/work-request-error/list>`

* :doc:`work-request-log-entry </cmdref/data-safe/work-request-log-entry>`

  * :doc:`list </cmdref/data-safe/work-request-log-entry/list>`


.. toctree::
    :hidden:

    /cmdref/data-safe/alert
    /cmdref/data-safe/alert-policy
    /cmdref/data-safe/alert-summary
    /cmdref/data-safe/audit-archive-retrieval
    /cmdref/data-safe/audit-event-summary
    /cmdref/data-safe/audit-policy
    /cmdref/data-safe/audit-policy-collection
    /cmdref/data-safe/audit-profile
    /cmdref/data-safe/audit-profile-analytic-collection
    /cmdref/data-safe/audit-trail
    /cmdref/data-safe/audit-trail-analytic-collection
    /cmdref/data-safe/discovery-job
    /cmdref/data-safe/discovery-job-result
    /cmdref/data-safe/library-masking-format
    /cmdref/data-safe/library-masking-format-summary
    /cmdref/data-safe/masked-column-summary
    /cmdref/data-safe/masking-column
    /cmdref/data-safe/masking-policy
    /cmdref/data-safe/masking-report
    /cmdref/data-safe/on-prem-connector
    /cmdref/data-safe/private-endpoint
    /cmdref/data-safe/report
    /cmdref/data-safe/report-definition
    /cmdref/data-safe/report-summary
    /cmdref/data-safe/security-assessment
    /cmdref/data-safe/sensitive-column
    /cmdref/data-safe/sensitive-data-model
    /cmdref/data-safe/sensitive-type
    /cmdref/data-safe/service
    /cmdref/data-safe/target-alert-policy-association
    /cmdref/data-safe/target-alert-policy-association-summary
    /cmdref/data-safe/target-database
    /cmdref/data-safe/user-assessment
    /cmdref/data-safe/work-request
    /cmdref/data-safe/work-request-error
    /cmdref/data-safe/work-request-log-entry
