Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataSafeClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DataSafeClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DataSafeClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DataSafeClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DataSafeWaiter

targetService

targetService: string = "DataSafe"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://datasafe.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

activateTargetDatabase

  • Reactivates a previously deactivated Data Safe target database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ActivateTargetDatabase API.

    Parameters

    Returns Promise<ActivateTargetDatabaseResponse>

    ActivateTargetDatabaseResponse

addMaskingColumnsFromSdm

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddMaskingColumnsFromSdm API.

    Parameters

    Returns Promise<AddMaskingColumnsFromSdmResponse>

    AddMaskingColumnsFromSdmResponse

alertsUpdate

  • Updates alerts in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AlertsUpdate API.

    Parameters

    Returns Promise<AlertsUpdateResponse>

    AlertsUpdateResponse

applyDiscoveryJobResults

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ApplyDiscoveryJobResults API.

    Parameters

    Returns Promise<ApplyDiscoveryJobResultsResponse>

    ApplyDiscoveryJobResultsResponse

applySdmMaskingPolicyDifference

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ApplySdmMaskingPolicyDifference API.

    Parameters

    Returns Promise<ApplySdmMaskingPolicyDifferenceResponse>

    ApplySdmMaskingPolicyDifferenceResponse

calculateAuditVolumeAvailable

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CalculateAuditVolumeAvailable API.

    Parameters

    Returns Promise<CalculateAuditVolumeAvailableResponse>

    CalculateAuditVolumeAvailableResponse

calculateAuditVolumeCollected

cancelWorkRequest

  • Cancel the specified work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelWorkRequest API.

    Parameters

    Returns Promise<CancelWorkRequestResponse>

    CancelWorkRequestResponse

changeAlertCompartment

  • Moves the specified alert into a different compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAlertCompartment API.

    Parameters

    Returns Promise<ChangeAlertCompartmentResponse>

    ChangeAlertCompartmentResponse

changeAuditArchiveRetrievalCompartment

changeAuditPolicyCompartment

  • Moves the specified audit policy and its dependent resources into a different compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAuditPolicyCompartment API.

    Parameters

    Returns Promise<ChangeAuditPolicyCompartmentResponse>

    ChangeAuditPolicyCompartmentResponse

changeAuditProfileCompartment

  • Moves the specified audit profile and its dependent resources into a different compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAuditProfileCompartment API.

    Parameters

    Returns Promise<ChangeAuditProfileCompartmentResponse>

    ChangeAuditProfileCompartmentResponse

changeDataSafePrivateEndpointCompartment

changeDatabaseSecurityConfigCompartment

changeDiscoveryJobCompartment

  • Moves the specified discovery job and its dependent resources into a different compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDiscoveryJobCompartment API.

    Parameters

    Returns Promise<ChangeDiscoveryJobCompartmentResponse>

    ChangeDiscoveryJobCompartmentResponse

changeLibraryMaskingFormatCompartment

changeMaskingPolicyCompartment

changeOnPremConnectorCompartment

changeReportCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeReportCompartment API.

    Parameters

    Returns Promise<ChangeReportCompartmentResponse>

    ChangeReportCompartmentResponse

changeReportDefinitionCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeReportDefinitionCompartment API.

    Parameters

    Returns Promise<ChangeReportDefinitionCompartmentResponse>

    ChangeReportDefinitionCompartmentResponse

changeRetention

  • Change the online and offline months . This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeRetention API.

    Parameters

    Returns Promise<ChangeRetentionResponse>

    ChangeRetentionResponse

changeSdmMaskingPolicyDifferenceCompartment

changeSecurityAssessmentCompartment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeSecurityAssessmentCompartment API.

    Parameters

    Returns Promise<ChangeSecurityAssessmentCompartmentResponse>

    ChangeSecurityAssessmentCompartmentResponse

changeSecurityPolicyCompartment

changeSecurityPolicyDeploymentCompartment

changeSensitiveDataModelCompartment

changeSensitiveTypeCompartment

changeSqlCollectionCompartment

changeSqlFirewallPolicyCompartment

changeTargetAlertPolicyAssociationCompartment

changeTargetDatabaseCompartment

changeUserAssessmentCompartment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeUserAssessmentCompartment API.

    Parameters

    Returns Promise<ChangeUserAssessmentCompartmentResponse>

    ChangeUserAssessmentCompartmentResponse

close

  • close(): void

compareSecurityAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CompareSecurityAssessment API.

    Parameters

    Returns Promise<CompareSecurityAssessmentResponse>

    CompareSecurityAssessmentResponse

compareUserAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CompareUserAssessment API.

    Parameters

    Returns Promise<CompareUserAssessmentResponse>

    CompareUserAssessmentResponse

createAuditArchiveRetrieval

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAuditArchiveRetrieval API.

    Parameters

    Returns Promise<CreateAuditArchiveRetrievalResponse>

    CreateAuditArchiveRetrievalResponse

createDataSafePrivateEndpoint

createDiscoveryJob

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDiscoveryJob API.

    Parameters

    Returns Promise<CreateDiscoveryJobResponse>

    CreateDiscoveryJobResponse

createLibraryMaskingFormat

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateLibraryMaskingFormat API.

    Parameters

    Returns Promise<CreateLibraryMaskingFormatResponse>

    CreateLibraryMaskingFormatResponse

createMaskingColumn

  • 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 conditional masking 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 group or compound masking that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMaskingColumn API.

    Parameters

    Returns Promise<CreateMaskingColumnResponse>

    CreateMaskingColumnResponse

createMaskingPolicy

  • Creates a new masking policy and associates it with a sensitive data model or a target database.

    To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations.

    You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations.

    After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMaskingPolicy API.

    Parameters

    Returns Promise<CreateMaskingPolicyResponse>

    CreateMaskingPolicyResponse

createOnPremConnector

createPeerTargetDatabase

  • Creates the peer target database under the primary target database in Data Safe. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePeerTargetDatabase API.

    Parameters

    Returns Promise<CreatePeerTargetDatabaseResponse>

    CreatePeerTargetDatabaseResponse

createReportDefinition

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateReportDefinition API.

    Parameters

    Returns Promise<CreateReportDefinitionResponse>

    CreateReportDefinitionResponse

createSdmMaskingPolicyDifference

  • Creates SDM masking policy difference for the specified masking policy. It finds the difference between masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the difference columns and apply them to the masking policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSdmMaskingPolicyDifference API.

    Parameters

    Returns Promise<CreateSdmMaskingPolicyDifferenceResponse>

    CreateSdmMaskingPolicyDifferenceResponse

createSecurityAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSecurityAssessment API.

    Parameters

    Returns Promise<CreateSecurityAssessmentResponse>

    CreateSecurityAssessmentResponse

createSensitiveColumn

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSensitiveColumn API.

    Parameters

    Returns Promise<CreateSensitiveColumnResponse>

    CreateSensitiveColumnResponse

createSensitiveDataModel

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSensitiveDataModel API.

    Parameters

    Returns Promise<CreateSensitiveDataModelResponse>

    CreateSensitiveDataModelResponse

createSensitiveType

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSensitiveType API.

    Parameters

    Returns Promise<CreateSensitiveTypeResponse>

    CreateSensitiveTypeResponse

createSqlCollection

createTargetAlertPolicyAssociation

createTargetDatabase

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTargetDatabase API.

    Parameters

    Returns Promise<CreateTargetDatabaseResponse>

    CreateTargetDatabaseResponse

createUserAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateUserAssessment API.

    Parameters

    Returns Promise<CreateUserAssessmentResponse>

    CreateUserAssessmentResponse

createWaiters

  • Creates a new DataSafeWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DataSafeWaiter

    The service waiters.

deactivateTargetDatabase

deleteAuditArchiveRetrieval

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAuditArchiveRetrieval API.

    Parameters

    Returns Promise<DeleteAuditArchiveRetrievalResponse>

    DeleteAuditArchiveRetrievalResponse

deleteAuditTrail

  • Deletes the specified audit trail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAuditTrail API.

    Parameters

    Returns Promise<DeleteAuditTrailResponse>

    DeleteAuditTrailResponse

deleteDataSafePrivateEndpoint

deleteDiscoveryJob

  • Deletes the specified discovery job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDiscoveryJob API.

    Parameters

    Returns Promise<DeleteDiscoveryJobResponse>

    DeleteDiscoveryJobResponse

deleteDiscoveryJobResult

deleteLibraryMaskingFormat

deleteMaskingColumn

deleteMaskingPolicy

deleteOnPremConnector

deletePeerTargetDatabase

deleteReportDefinition

  • Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteReportDefinition API.

    Parameters

    Returns Promise<DeleteReportDefinitionResponse>

    DeleteReportDefinitionResponse

deleteSdmMaskingPolicyDifference

deleteSecurityAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSecurityAssessment API.

    Parameters

    Returns Promise<DeleteSecurityAssessmentResponse>

    DeleteSecurityAssessmentResponse

deleteSensitiveColumn

deleteSensitiveDataModel

deleteSensitiveType

deleteSqlCollection

deleteSqlFirewallPolicy

deleteTargetAlertPolicyAssociation

deleteTargetDatabase

  • Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTargetDatabase API.

    Parameters

    Returns Promise<DeleteTargetDatabaseResponse>

    DeleteTargetDatabaseResponse

deleteUserAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteUserAssessment API.

    Parameters

    Returns Promise<DeleteUserAssessmentResponse>

    DeleteUserAssessmentResponse

discoverAuditTrails

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DiscoverAuditTrails API.

    Parameters

    Returns Promise<DiscoverAuditTrailsResponse>

    DiscoverAuditTrailsResponse

downloadDiscoveryReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadDiscoveryReport API.

    Parameters

    Returns Promise<DownloadDiscoveryReportResponse>

    DownloadDiscoveryReportResponse

downloadMaskingLog

  • Downloads the masking log generated by the last masking operation on a target database using the specified masking policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadMaskingLog API.

    Parameters

    Returns Promise<DownloadMaskingLogResponse>

    DownloadMaskingLogResponse

downloadMaskingPolicy

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadMaskingPolicy API.

    Parameters

    Returns Promise<DownloadMaskingPolicyResponse>

    DownloadMaskingPolicyResponse

downloadMaskingReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadMaskingReport API.

    Parameters

    Returns Promise<DownloadMaskingReportResponse>

    DownloadMaskingReportResponse

downloadPrivilegeScript

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadPrivilegeScript API.

    Parameters

    Returns Promise<DownloadPrivilegeScriptResponse>

    DownloadPrivilegeScriptResponse

downloadSecurityAssessmentReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadSecurityAssessmentReport API.

    Parameters

    Returns Promise<DownloadSecurityAssessmentReportResponse>

    DownloadSecurityAssessmentReportResponse

downloadSensitiveDataModel

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadSensitiveDataModel API.

    Parameters

    Returns Promise<DownloadSensitiveDataModelResponse>

    DownloadSensitiveDataModelResponse

downloadUserAssessmentReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadUserAssessmentReport API.

    Parameters

    Returns Promise<DownloadUserAssessmentReportResponse>

    DownloadUserAssessmentReportResponse

enableDataSafeConfiguration

generateDiscoveryReportForDownload

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateDiscoveryReportForDownload API.

    Parameters

    Returns Promise<GenerateDiscoveryReportForDownloadResponse>

    GenerateDiscoveryReportForDownloadResponse

generateMaskingPolicyForDownload

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateMaskingPolicyForDownload API.

    Parameters

    Returns Promise<GenerateMaskingPolicyForDownloadResponse>

    GenerateMaskingPolicyForDownloadResponse

generateMaskingReportForDownload

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateMaskingReportForDownload API.

    Parameters

    Returns Promise<GenerateMaskingReportForDownloadResponse>

    GenerateMaskingReportForDownloadResponse

generateOnPremConnectorConfiguration

generateReport

  • Generates a .xls or .pdf report based on parameters and report definition. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateReport API.

    Parameters

    Returns Promise<GenerateReportResponse>

    GenerateReportResponse

generateSecurityAssessmentReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateSecurityAssessmentReport API.

    Parameters

    Returns Promise<GenerateSecurityAssessmentReportResponse>

    GenerateSecurityAssessmentReportResponse

generateSensitiveDataModelForDownload

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateSensitiveDataModelForDownload API.

    Parameters

    Returns Promise<GenerateSensitiveDataModelForDownloadResponse>

    GenerateSensitiveDataModelForDownloadResponse

generateSqlFirewallPolicy

  • Generates or appends to the SQL Firewall policy using the specified SQL collection. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateSqlFirewallPolicy API.

    Parameters

    Returns Promise<GenerateSqlFirewallPolicyResponse>

    GenerateSqlFirewallPolicyResponse

generateUserAssessmentReport

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateUserAssessmentReport API.

    Parameters

    Returns Promise<GenerateUserAssessmentReportResponse>

    GenerateUserAssessmentReportResponse

getAlert

  • Gets the details of the specified alerts. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAlert API.

    Parameters

    Returns Promise<GetAlertResponse>

    GetAlertResponse

getAlertPolicy

  • Gets the details of alert policy by its ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAlertPolicy API.

    Parameters

    Returns Promise<GetAlertPolicyResponse>

    GetAlertPolicyResponse

getAuditArchiveRetrieval

getAuditPolicy

  • Gets a audit policy by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAuditPolicy API.

    Parameters

    Returns Promise<GetAuditPolicyResponse>

    GetAuditPolicyResponse

getAuditProfile

  • Gets the details of audit profile resource and associated audit trails of the audit profile. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAuditProfile API.

    Parameters

    Returns Promise<GetAuditProfileResponse>

    GetAuditProfileResponse

getAuditTrail

  • Gets the details of audit trail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAuditTrail API.

    Parameters

    Returns Promise<GetAuditTrailResponse>

    GetAuditTrailResponse

getCompatibleFormatsForDataTypes

  • 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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCompatibleFormatsForDataTypes API.

    Parameters

    Returns Promise<GetCompatibleFormatsForDataTypesResponse>

    GetCompatibleFormatsForDataTypesResponse

getCompatibleFormatsForSensitiveTypes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCompatibleFormatsForSensitiveTypes API.

    Parameters

    Returns Promise<GetCompatibleFormatsForSensitiveTypesResponse>

    GetCompatibleFormatsForSensitiveTypesResponse

getDataSafeConfiguration

getDataSafePrivateEndpoint

getDatabaseSecurityConfig

getDatabaseTableAccessEntry

getDatabaseViewAccessEntry

getDifferenceColumn

  • Gets the details of the specified SDM Masking policy difference column. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDifferenceColumn API.

    Parameters

    Returns Promise<GetDifferenceColumnResponse>

    GetDifferenceColumnResponse

getDiscoveryJob

  • Gets the details of the specified discovery job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDiscoveryJob API.

    Parameters

    Returns Promise<GetDiscoveryJobResponse>

    GetDiscoveryJobResponse

getDiscoveryJobResult

  • Gets the details of the specified discovery result. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDiscoveryJobResult API.

    Parameters

    Returns Promise<GetDiscoveryJobResultResponse>

    GetDiscoveryJobResultResponse

getLibraryMaskingFormat

getMaskingColumn

  • Gets the details of the specified masking column. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMaskingColumn API.

    Parameters

    Returns Promise<GetMaskingColumnResponse>

    GetMaskingColumnResponse

getMaskingPolicy

  • Gets the details of the specified masking policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMaskingPolicy API.

    Parameters

    Returns Promise<GetMaskingPolicyResponse>

    GetMaskingPolicyResponse

getMaskingReport

  • Gets the details of the specified masking report. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMaskingReport API.

    Parameters

    Returns Promise<GetMaskingReportResponse>

    GetMaskingReportResponse

getOnPremConnector

  • Gets the details of the specified on-premises connector. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetOnPremConnector API.

    Parameters

    Returns Promise<GetOnPremConnectorResponse>

    GetOnPremConnectorResponse

getPeerTargetDatabase

  • Returns the details of the specified Data Safe peer target database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPeerTargetDatabase API.

    Parameters

    Returns Promise<GetPeerTargetDatabaseResponse>

    GetPeerTargetDatabaseResponse

getProfile

  • Lists the details of given profile available on the target.

    The GetProfile operation returns only the profiles in the specified 'userAssessmentId'. This does not include any subcompartments of the current compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProfile API.

    Parameters

    Returns Promise<GetProfileResponse>

    GetProfileResponse

getReport

  • Gets a report by identifier This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetReport API.

    Parameters

    Returns Promise<GetReportResponse>

    GetReportResponse

getReportContent

  • Downloads the specified report in the form of .xls or .pdf. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetReportContent API.

    Parameters

    Returns Promise<GetReportContentResponse>

    GetReportContentResponse

getReportDefinition

  • Gets the details of report definition specified by the identifier This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetReportDefinition API.

    Parameters

    Returns Promise<GetReportDefinitionResponse>

    GetReportDefinitionResponse

getSdmMaskingPolicyDifference

getSecurityAssessment

  • Gets the details of the specified security assessment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecurityAssessment API.

    Parameters

    Returns Promise<GetSecurityAssessmentResponse>

    GetSecurityAssessmentResponse

getSecurityAssessmentComparison

getSecurityPolicy

  • Gets a security policy by the specified OCID of the security policy resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecurityPolicy API.

    Parameters

    Returns Promise<GetSecurityPolicyResponse>

    GetSecurityPolicyResponse

getSecurityPolicyDeployment

getSecurityPolicyEntryState

getSecurityPolicyReport

  • Gets a security policy report by the specified OCID of the security policy report resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecurityPolicyReport API.

    Parameters

    Returns Promise<GetSecurityPolicyReportResponse>

    GetSecurityPolicyReportResponse

getSensitiveColumn

  • Gets the details of the specified sensitive column. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSensitiveColumn API.

    Parameters

    Returns Promise<GetSensitiveColumnResponse>

    GetSensitiveColumnResponse

getSensitiveDataModel

  • Gets the details of the specified sensitive data model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSensitiveDataModel API.

    Parameters

    Returns Promise<GetSensitiveDataModelResponse>

    GetSensitiveDataModelResponse

getSensitiveType

  • Gets the details of the specified sensitive type. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSensitiveType API.

    Parameters

    Returns Promise<GetSensitiveTypeResponse>

    GetSensitiveTypeResponse

getSqlCollection

  • Gets a SQL collection by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSqlCollection API.

    Parameters

    Returns Promise<GetSqlCollectionResponse>

    GetSqlCollectionResponse

getSqlFirewallPolicy

getTargetAlertPolicyAssociation

getTargetDatabase

  • Returns the details of the specified Data Safe target database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTargetDatabase API.

    Parameters

    Returns Promise<GetTargetDatabaseResponse>

    GetTargetDatabaseResponse

getUserAssessment

  • Gets a user assessment by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUserAssessment API.

    Parameters

    Returns Promise<GetUserAssessmentResponse>

    GetUserAssessmentResponse

getUserAssessmentComparison

  • Gets the details of the comparison report for the user assessments submitted for comparison. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUserAssessmentComparison API.

    Parameters

    Returns Promise<GetUserAssessmentComparisonResponse>

    GetUserAssessmentComparisonResponse

getWaiters

getWorkRequest

  • Gets the details of the specified work request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAlertAnalytics

  • Returns the aggregation details of the alerts.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlertAnalytics API.

    Parameters

    Returns Promise<ListAlertAnalyticsResponse>

    ListAlertAnalyticsResponse

listAlertPolicies

  • Gets a list of all alert policies.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlertPolicies API.

    Parameters

    Returns Promise<ListAlertPoliciesResponse>

    ListAlertPoliciesResponse

listAlertPolicyRules

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlertPolicyRules API.

    Parameters

    Returns Promise<ListAlertPolicyRulesResponse>

    ListAlertPolicyRulesResponse

listAlerts

  • Gets a list of all alerts.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlerts API.

    Parameters

    Returns Promise<ListAlertsResponse>

    ListAlertsResponse

listAllColumns

  • NOTE: This function is deprecated in favor of listColumnsRecordIterator function. Creates a new async iterator which will iterate over the models.ColumnSummary objects contained in responses from the listColumns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ColumnSummary>

listAllColumnsResponses

  • NOTE: This function is deprecated in favor of listColumnsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listColumns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListColumnsResponse>

listAllDataSafePrivateEndpoints

  • NOTE: This function is deprecated in favor of listDataSafePrivateEndpointsRecordIterator function. Creates a new async iterator which will iterate over the models.DataSafePrivateEndpointSummary objects contained in responses from the listDataSafePrivateEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DataSafePrivateEndpointSummary>

listAllDataSafePrivateEndpointsResponses

listAllFindings

  • NOTE: This function is deprecated in favor of listFindingsRecordIterator function. Creates a new async iterator which will iterate over the models.FindingSummary objects contained in responses from the listFindings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<FindingSummary>

listAllFindingsResponses

  • NOTE: This function is deprecated in favor of listFindingsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listFindings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListFindingsResponse>

listAllGrants

  • NOTE: This function is deprecated in favor of listGrantsRecordIterator function. Creates a new async iterator which will iterate over the models.GrantSummary objects contained in responses from the listGrants operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GrantSummary>

listAllGrantsResponses

  • NOTE: This function is deprecated in favor of listGrantsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listGrants operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGrantsResponse>

listAllOnPremConnectors

  • NOTE: This function is deprecated in favor of listOnPremConnectorsRecordIterator function. Creates a new async iterator which will iterate over the models.OnPremConnectorSummary objects contained in responses from the listOnPremConnectors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OnPremConnectorSummary>

listAllOnPremConnectorsResponses

  • NOTE: This function is deprecated in favor of listOnPremConnectorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listOnPremConnectors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListOnPremConnectorsResponse>

listAllProfileAnalytics

  • NOTE: This function is deprecated in favor of listProfileAnalyticsRecordIterator function. Creates a new async iterator which will iterate over the models.ProfileAggregation objects contained in responses from the listProfileAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProfileAggregation>

listAllProfileAnalyticsResponses

  • NOTE: This function is deprecated in favor of listProfileAnalyticsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listProfileAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListProfileAnalyticsResponse>

listAllProfileSummaries

  • NOTE: This function is deprecated in favor of listProfileSummariesRecordIterator function. Creates a new async iterator which will iterate over the models.ProfileSummary objects contained in responses from the listProfileSummaries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProfileSummary>

listAllProfileSummariesResponses

  • NOTE: This function is deprecated in favor of listProfileSummariesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listProfileSummaries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListProfileSummariesResponse>

listAllRoles

  • NOTE: This function is deprecated in favor of listRolesRecordIterator function. Creates a new async iterator which will iterate over the models.RoleSummary objects contained in responses from the listRoles operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRolesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RoleSummary>

listAllRolesResponses

  • NOTE: This function is deprecated in favor of listRolesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRoles operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRolesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRolesResponse>

listAllSchemas

  • NOTE: This function is deprecated in favor of listSchemasRecordIterator function. Creates a new async iterator which will iterate over the models.SchemaSummary objects contained in responses from the listSchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SchemaSummary>

listAllSchemasResponses

  • NOTE: This function is deprecated in favor of listSchemasResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSchemasResponse>

listAllSecurityAssessments

  • NOTE: This function is deprecated in favor of listSecurityAssessmentsRecordIterator function. Creates a new async iterator which will iterate over the models.SecurityAssessmentSummary objects contained in responses from the listSecurityAssessments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecurityAssessmentSummary>

listAllSecurityAssessmentsResponses

  • NOTE: This function is deprecated in favor of listSecurityAssessmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSecurityAssessments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSecurityAssessmentsResponse>

listAllTables

  • NOTE: This function is deprecated in favor of listTablesRecordIterator function. Creates a new async iterator which will iterate over the models.TableSummary objects contained in responses from the listTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TableSummary>

listAllTablesResponses

  • NOTE: This function is deprecated in favor of listTablesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTablesResponse>

listAllTargetDatabases

  • NOTE: This function is deprecated in favor of listTargetDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.TargetDatabaseSummary objects contained in responses from the listTargetDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TargetDatabaseSummary>

listAllTargetDatabasesResponses

  • NOTE: This function is deprecated in favor of listTargetDatabasesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTargetDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTargetDatabasesResponse>

listAllUserAnalytics

  • NOTE: This function is deprecated in favor of listUserAnalyticsRecordIterator function. Creates a new async iterator which will iterate over the models.UserAggregation objects contained in responses from the listUserAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserAggregation>

listAllUserAnalyticsResponses

  • NOTE: This function is deprecated in favor of listUserAnalyticsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listUserAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListUserAnalyticsResponse>

listAllUserAssessments

  • NOTE: This function is deprecated in favor of listUserAssessmentsRecordIterator function. Creates a new async iterator which will iterate over the models.UserAssessmentSummary objects contained in responses from the listUserAssessments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserAssessmentSummary>

listAllUserAssessmentsResponses

  • NOTE: This function is deprecated in favor of listUserAssessmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listUserAssessments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListUserAssessmentsResponse>

listAllUsers

  • NOTE: This function is deprecated in favor of listUsersRecordIterator function. Creates a new async iterator which will iterate over the models.UserSummary objects contained in responses from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<UserSummary>

listAllUsersResponses

  • NOTE: This function is deprecated in favor of listUsersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListUsersResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAuditArchiveRetrievals

listAuditEventAnalytics

  • By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the summaryField query parameter.

    *Example:** /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge \"2021-06-13T23:49:14\")

    /ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc.

    /ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditEventAnalytics API.

    Parameters

    Returns Promise<ListAuditEventAnalyticsResponse>

    ListAuditEventAnalyticsResponse

listAuditEvents

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditEvents API.

    Parameters

    Returns Promise<ListAuditEventsResponse>

    ListAuditEventsResponse

listAuditPolicies

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditPolicies API.

    Parameters

    Returns Promise<ListAuditPoliciesResponse>

    ListAuditPoliciesResponse

listAuditPolicyAnalytics

  • Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform SummarizedAuditPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    *Example:** ListAuditPolicyAnalytics?groupBy=auditPolicyCategory

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditPolicyAnalytics API.

    Parameters

    Returns Promise<ListAuditPolicyAnalyticsResponse>

    ListAuditPolicyAnalyticsResponse

listAuditProfileAnalytics

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditProfileAnalytics API.

    Parameters

    Returns Promise<ListAuditProfileAnalyticsResponse>

    ListAuditProfileAnalyticsResponse

listAuditProfiles

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditProfiles API.

    Parameters

    Returns Promise<ListAuditProfilesResponse>

    ListAuditProfilesResponse

listAuditTrailAnalytics

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditTrailAnalytics API.

    Parameters

    Returns Promise<ListAuditTrailAnalyticsResponse>

    ListAuditTrailAnalyticsResponse

listAuditTrails

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuditTrails API.

    Parameters

    Returns Promise<ListAuditTrailsResponse>

    ListAuditTrailsResponse

listAvailableAuditVolumes

  • Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAvailableAuditVolumes API.

    Parameters

    Returns Promise<ListAvailableAuditVolumesResponse>

    ListAvailableAuditVolumesResponse

listCollectedAuditVolumes

listColumns

  • Returns a list of column metadata objects.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListColumns API.

    Parameters

    Returns Promise<ListColumnsResponse>

    ListColumnsResponse

listColumnsRecordIterator

  • Creates a new async iterator which will iterate over the models.ColumnSummary objects contained in responses from the listColumns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ColumnSummary>

listColumnsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listColumns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListColumnsResponse>

listDataSafePrivateEndpoints

listDataSafePrivateEndpointsRecordIterator

listDataSafePrivateEndpointsResponseIterator

listDatabaseSecurityConfigs

  • Retrieves a list of all database security configurations in Data Safe.

    The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListDatabaseSecurityConfigs on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseSecurityConfigs API.

    Parameters

    Returns Promise<ListDatabaseSecurityConfigsResponse>

    ListDatabaseSecurityConfigsResponse

listDatabaseTableAccessEntries

  • Retrieves a list of all database table access entries in Data Safe.

    The ListDatabaseTableAccessEntries operation returns only the database table access reports for the specified security policy report.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseTableAccessEntries API.

    Parameters

    Returns Promise<ListDatabaseTableAccessEntriesResponse>

    ListDatabaseTableAccessEntriesResponse

listDatabaseViewAccessEntries

  • Retrieves a list of all database view access entries in Data Safe.

    The ListDatabaseViewAccessEntries operation returns only the database view access objects for the specified security policy report.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseViewAccessEntries API.

    Parameters

    Returns Promise<ListDatabaseViewAccessEntriesResponse>

    ListDatabaseViewAccessEntriesResponse

listDifferenceColumns

  • Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDifferenceColumns API.

    Parameters

    Returns Promise<ListDifferenceColumnsResponse>

    ListDifferenceColumnsResponse

listDiscoveryAnalytics

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDiscoveryAnalytics API.

    Parameters

    Returns Promise<ListDiscoveryAnalyticsResponse>

    ListDiscoveryAnalyticsResponse

listDiscoveryJobResults

  • Gets a list of discovery results based on the specified query parameters. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDiscoveryJobResults API.

    Parameters

    Returns Promise<ListDiscoveryJobResultsResponse>

    ListDiscoveryJobResultsResponse

listDiscoveryJobs

  • Gets a list of incremental discovery jobs based on the specified query parameters. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDiscoveryJobs API.

    Parameters

    Returns Promise<ListDiscoveryJobsResponse>

    ListDiscoveryJobsResponse

listFindingAnalytics

  • Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state of security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey, and as well as get the list of the targets that match the condition. This data is especially useful content for the statistic chart or to support analytics.

    When you perform the ListFindingAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFindingAnalytics API.

    Parameters

    Returns Promise<ListFindingAnalyticsResponse>

    ListFindingAnalyticsResponse

listFindings

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFindings API.

    Parameters

    Returns Promise<ListFindingsResponse>

    ListFindingsResponse

listFindingsChangeAuditLogs

  • List all changes made by user to risk level of findings of the specified assessment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFindingsChangeAuditLogs API.

    Parameters

    Returns Promise<ListFindingsChangeAuditLogsResponse>

    ListFindingsChangeAuditLogsResponse

listFindingsRecordIterator

  • Creates a new async iterator which will iterate over the models.FindingSummary objects contained in responses from the listFindings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<FindingSummary>

listFindingsResponseIterator

listGrants

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListGrants API.

    Parameters

    Returns Promise<ListGrantsResponse>

    ListGrantsResponse

listGrantsRecordIterator

  • Creates a new async iterator which will iterate over the models.GrantSummary objects contained in responses from the listGrants operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GrantSummary>

listGrantsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listGrants operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGrantsResponse>

listLibraryMaskingFormats

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListLibraryMaskingFormats API.

    Parameters

    Returns Promise<ListLibraryMaskingFormatsResponse>

    ListLibraryMaskingFormatsResponse

listMaskedColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskedColumns API.

    Parameters

    Returns Promise<ListMaskedColumnsResponse>

    ListMaskedColumnsResponse

listMaskingAnalytics

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingAnalytics API.

    Parameters

    Returns Promise<ListMaskingAnalyticsResponse>

    ListMaskingAnalyticsResponse

listMaskingColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingColumns API.

    Parameters

    Returns Promise<ListMaskingColumnsResponse>

    ListMaskingColumnsResponse

listMaskingObjects

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingObjects API.

    Parameters

    Returns Promise<ListMaskingObjectsResponse>

    ListMaskingObjectsResponse

listMaskingPolicies

  • Gets a list of masking policies based on the specified query parameters. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingPolicies API.

    Parameters

    Returns Promise<ListMaskingPoliciesResponse>

    ListMaskingPoliciesResponse

listMaskingReports

  • Gets a list of masking reports based on the specified query parameters. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingReports API.

    Parameters

    Returns Promise<ListMaskingReportsResponse>

    ListMaskingReportsResponse

listMaskingSchemas

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMaskingSchemas API.

    Parameters

    Returns Promise<ListMaskingSchemasResponse>

    ListMaskingSchemasResponse

listOnPremConnectors

listOnPremConnectorsRecordIterator

  • Creates a new async iterator which will iterate over the models.OnPremConnectorSummary objects contained in responses from the listOnPremConnectors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OnPremConnectorSummary>

listOnPremConnectorsResponseIterator

listPeerTargetDatabases

  • Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPeerTargetDatabases API.

    Parameters

    Returns Promise<ListPeerTargetDatabasesResponse>

    ListPeerTargetDatabasesResponse

listProfileAnalytics

  • Gets a list of aggregated user profile details in the specified compartment. This provides information about the overall profiles available. For example, the user profile details include how many users have the profile assigned and do how many use password verification function. This data is especially useful content for dashboards or to support analytics.

    When you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.

    The parameter compartmentIdInSubtree applies when you perform ListProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

    To use ListProfileAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProfileAnalytics API.

    Parameters

    Returns Promise<ListProfileAnalyticsResponse>

    ListProfileAnalyticsResponse

listProfileAnalyticsRecordIterator

  • Creates a new async iterator which will iterate over the models.ProfileAggregation objects contained in responses from the listProfileAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProfileAggregation>

listProfileAnalyticsResponseIterator

listProfileSummaries

  • Gets a list of user profiles containing the profile details along with the target id and user counts.

    The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration.

    The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'.

    The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProfileSummaries API.

    Parameters

    Returns Promise<ListProfileSummariesResponse>

    ListProfileSummariesResponse

listProfileSummariesRecordIterator

  • Creates a new async iterator which will iterate over the models.ProfileSummary objects contained in responses from the listProfileSummaries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProfileSummary>

listProfileSummariesResponseIterator

listReportDefinitions

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListReportDefinitions API.

    Parameters

    Returns Promise<ListReportDefinitionsResponse>

    ListReportDefinitionsResponse

listReports

  • Gets a list of all the reports in the compartment. It contains information such as report generation time. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListReports API.

    Parameters

    Returns Promise<ListReportsResponse>

    ListReportsResponse

listRoleGrantPaths

  • Retrieves a list of all role grant paths for a particular user.

    The ListRoleGrantPaths operation returns only the role grant paths for the specified security policy report.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRoleGrantPaths API.

    Parameters

    Returns Promise<ListRoleGrantPathsResponse>

    ListRoleGrantPathsResponse

listRoles

  • Returns a list of role metadata objects.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRoles API.

    Parameters

    Returns Promise<ListRolesResponse>

    ListRolesResponse

listRolesRecordIterator

  • Creates a new async iterator which will iterate over the models.RoleSummary objects contained in responses from the listRoles operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRolesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RoleSummary>

listRolesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listRoles operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRolesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRolesResponse>

listSchemas

  • Returns list of schema.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSchemas API.

    Parameters

    Returns Promise<ListSchemasResponse>

    ListSchemasResponse

listSchemasRecordIterator

  • Creates a new async iterator which will iterate over the models.SchemaSummary objects contained in responses from the listSchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SchemaSummary>

listSchemasResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listSchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSchemasResponse>

listSdmMaskingPolicyDifferences

listSecurityAssessments

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityAssessments API.

    Parameters

    Returns Promise<ListSecurityAssessmentsResponse>

    ListSecurityAssessmentsResponse

listSecurityAssessmentsRecordIterator

listSecurityAssessmentsResponseIterator

listSecurityFeatureAnalytics

  • Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the overall security controls, by returning the counting number of the target databases using the security features.

    When you perform the ListSecurityFeatureAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityFeatureAnalytics API.

    Parameters

    Returns Promise<ListSecurityFeatureAnalyticsResponse>

    ListSecurityFeatureAnalyticsResponse

listSecurityFeatures

  • Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityFeatures API.

    Parameters

    Returns Promise<ListSecurityFeaturesResponse>

    ListSecurityFeaturesResponse

listSecurityPolicies

  • Retrieves a list of all security policies in Data Safe.

    The ListSecurityPolicies operation returns only the security policies in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityPolicies API.

    Parameters

    Returns Promise<ListSecurityPoliciesResponse>

    ListSecurityPoliciesResponse

listSecurityPolicyDeployments

  • Retrieves a list of all security policy deployments in Data Safe.

    The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicyDeployments on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityPolicyDeployments API.

    Parameters

    Returns Promise<ListSecurityPolicyDeploymentsResponse>

    ListSecurityPolicyDeploymentsResponse

listSecurityPolicyEntryStates

  • Retrieves a list of all security policy entry states in Data Safe.

    The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityPolicyEntryStates API.

    Parameters

    Returns Promise<ListSecurityPolicyEntryStatesResponse>

    ListSecurityPolicyEntryStatesResponse

listSecurityPolicyReports

  • Retrieves a list of all security policy reports in Data Safe.

    The ListSecurityPolicyReports operation returns only the security policy reports in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSecurityPolicyReports 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityPolicyReports API.

    Parameters

    Returns Promise<ListSecurityPolicyReportsResponse>

    ListSecurityPolicyReportsResponse

listSensitiveColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSensitiveColumns API.

    Parameters

    Returns Promise<ListSensitiveColumnsResponse>

    ListSensitiveColumnsResponse

listSensitiveDataModels

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSensitiveDataModels API.

    Parameters

    Returns Promise<ListSensitiveDataModelsResponse>

    ListSensitiveDataModelsResponse

listSensitiveObjects

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSensitiveObjects API.

    Parameters

    Returns Promise<ListSensitiveObjectsResponse>

    ListSensitiveObjectsResponse

listSensitiveSchemas

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSensitiveSchemas API.

    Parameters

    Returns Promise<ListSensitiveSchemasResponse>

    ListSensitiveSchemasResponse

listSensitiveTypes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSensitiveTypes API.

    Parameters

    Returns Promise<ListSensitiveTypesResponse>

    ListSensitiveTypesResponse

listSqlCollectionAnalytics

  • Retrieves a list of all SQL collection analytics in Data Safe.

    The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlCollectionAnalytics API.

    Parameters

    Returns Promise<ListSqlCollectionAnalyticsResponse>

    ListSqlCollectionAnalyticsResponse

listSqlCollectionLogInsights

listSqlCollections

  • Retrieves a list of all SQL collections in Data Safe.

    The ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlCollections API.

    Parameters

    Returns Promise<ListSqlCollectionsResponse>

    ListSqlCollectionsResponse

listSqlFirewallAllowedSqlAnalytics

  • Returns the aggregation details of all SQL Firewall allowed SQL statements.

    The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallAllowedSqlAnalytics on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlFirewallAllowedSqlAnalytics API.

    Parameters

    Returns Promise<ListSqlFirewallAllowedSqlAnalyticsResponse>

    ListSqlFirewallAllowedSqlAnalyticsResponse

listSqlFirewallAllowedSqls

  • Retrieves a list of all SQL Firewall allowed SQL statements.

    The ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlFirewallAllowedSqls API.

    Parameters

    Returns Promise<ListSqlFirewallAllowedSqlsResponse>

    ListSqlFirewallAllowedSqlsResponse

listSqlFirewallPolicies

  • Retrieves a list of all SQL Firewall policies.

    The ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified `compartmentId`.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform ListSqlFirewallPolicies on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlFirewallPolicies API.

    Parameters

    Returns Promise<ListSqlFirewallPoliciesResponse>

    ListSqlFirewallPoliciesResponse

listSqlFirewallPolicyAnalytics

  • Gets a list of aggregated SQL Firewall policy details.

    The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`.

    The parameter `compartmentIdInSubtree` applies when you perform SummarizedSqlFirewallPolicyInfo on the specified `compartmentId` and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlFirewallPolicyAnalytics API.

    Parameters

    Returns Promise<ListSqlFirewallPolicyAnalyticsResponse>

    ListSqlFirewallPolicyAnalyticsResponse

listSqlFirewallViolationAnalytics

listSqlFirewallViolations

listTables

  • Returns a list of table metadata objects.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTables API.

    Parameters

    Returns Promise<ListTablesResponse>

    ListTablesResponse

listTablesRecordIterator

  • Creates a new async iterator which will iterate over the models.TableSummary objects contained in responses from the listTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TableSummary>

listTablesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTablesResponse>

listTargetAlertPolicyAssociations

listTargetDatabases

  • Returns the list of registered target databases in Data Safe.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTargetDatabases API.

    Parameters

    Returns Promise<ListTargetDatabasesResponse>

    ListTargetDatabasesResponse

listTargetDatabasesRecordIterator

  • Creates a new async iterator which will iterate over the models.TargetDatabaseSummary objects contained in responses from the listTargetDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TargetDatabaseSummary>

listTargetDatabasesResponseIterator

listUserAccessAnalytics

  • Gets a list of aggregated user access analytics in the specified target in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUserAccessAnalytics API.

    Parameters

    Returns Promise<ListUserAccessAnalyticsResponse>

    ListUserAccessAnalyticsResponse

listUserAnalytics

  • Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics.

    When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then \"Not Authorized\" is returned.

    The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

    To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUserAnalytics API.

    Parameters

    Returns Promise<ListUserAnalyticsResponse>

    ListUserAnalyticsResponse

listUserAnalyticsRecordIterator

  • Creates a new async iterator which will iterate over the models.UserAggregation objects contained in responses from the listUserAnalytics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserAggregation>

listUserAnalyticsResponseIterator

listUserAssessments

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUserAssessments API.

    Parameters

    Returns Promise<ListUserAssessmentsResponse>

    ListUserAssessmentsResponse

listUserAssessmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.UserAssessmentSummary objects contained in responses from the listUserAssessments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserAssessmentSummary>

listUserAssessmentsResponseIterator

listUsers

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUsers API.

    Parameters

    Returns Promise<ListUsersResponse>

    ListUsersResponse

listUsersRecordIterator

  • Creates a new async iterator which will iterate over the models.UserSummary objects contained in responses from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<UserSummary>

listUsersResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListUsersResponse>

listWorkRequestErrors

  • Gets a list of errors for the specified work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

  • Gets a list of work requests.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

maskData

  • Masks data using the specified masking policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use MaskData API.

    Parameters

    Returns Promise<MaskDataResponse>

    MaskDataResponse

modifyGlobalSettings

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ModifyGlobalSettings API.

    Parameters

    Returns Promise<ModifyGlobalSettingsResponse>

    ModifyGlobalSettingsResponse

patchAlerts

  • Updates the status of one or more alert specified by the alert IDs. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchAlerts API.

    Parameters

    Returns Promise<PatchAlertsResponse>

    PatchAlertsResponse

patchDiscoveryJobResults

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchDiscoveryJobResults API.

    Parameters

    Returns Promise<PatchDiscoveryJobResultsResponse>

    PatchDiscoveryJobResultsResponse

patchMaskingColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchMaskingColumns API.

    Parameters

    Returns Promise<PatchMaskingColumnsResponse>

    PatchMaskingColumnsResponse

patchSdmMaskingPolicyDifferenceColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchSdmMaskingPolicyDifferenceColumns API.

    Parameters

    Returns Promise<PatchSdmMaskingPolicyDifferenceColumnsResponse>

    PatchSdmMaskingPolicyDifferenceColumnsResponse

patchSensitiveColumns

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchSensitiveColumns API.

    Parameters

    Returns Promise<PatchSensitiveColumnsResponse>

    PatchSensitiveColumnsResponse

patchTargetAlertPolicyAssociation

provisionAuditPolicy

purgeSqlCollectionLogs

  • Purge the SQL collection logs for the specified SqlCollection. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PurgeSqlCollectionLogs API.

    Parameters

    Returns Promise<PurgeSqlCollectionLogsResponse>

    PurgeSqlCollectionLogsResponse

refreshDatabaseSecurityConfiguration

refreshSecurityAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RefreshSecurityAssessment API.

    Parameters

    Returns Promise<RefreshSecurityAssessmentResponse>

    RefreshSecurityAssessmentResponse

refreshSqlCollectionLogInsights

refreshTargetDatabase

  • Refreshes the Data Safe target database to update it's state.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RefreshTargetDatabase API.

    Parameters

    Returns Promise<RefreshTargetDatabaseResponse>

    RefreshTargetDatabaseResponse

refreshUserAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RefreshUserAssessment API.

    Parameters

    Returns Promise<RefreshUserAssessmentResponse>

    RefreshUserAssessmentResponse

removeScheduleReport

resumeAuditTrail

  • Resumes the specified audit trail once it got stopped. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResumeAuditTrail API.

    Parameters

    Returns Promise<ResumeAuditTrailResponse>

    ResumeAuditTrailResponse

resumeWorkRequest

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResumeWorkRequest API.

    Parameters

    Returns Promise<ResumeWorkRequestResponse>

    ResumeWorkRequestResponse

retrieveAuditPolicies

  • Retrieves the audit policy details from the source target database. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RetrieveAuditPolicies API.

    Parameters

    Returns Promise<RetrieveAuditPoliciesResponse>

    RetrieveAuditPoliciesResponse

scheduleReport

  • Schedules a .xls or .pdf report based on parameters and report definition. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ScheduleReport API.

    Parameters

    Returns Promise<ScheduleReportResponse>

    ScheduleReportResponse

setSecurityAssessmentBaseline

  • 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'. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SetSecurityAssessmentBaseline API.

    Parameters

    Returns Promise<SetSecurityAssessmentBaselineResponse>

    SetSecurityAssessmentBaselineResponse

setUserAssessmentBaseline

  • 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'. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SetUserAssessmentBaseline API.

    Parameters

    Returns Promise<SetUserAssessmentBaselineResponse>

    SetUserAssessmentBaselineResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startAuditTrail

  • Starts collection of audit records on the specified audit trail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StartAuditTrail API.

    Parameters

    Returns Promise<StartAuditTrailResponse>

    StartAuditTrailResponse

startSqlCollection

stopAuditTrail

  • Stops the specified audit trail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopAuditTrail API.

    Parameters

    Returns Promise<StopAuditTrailResponse>

    StopAuditTrailResponse

stopSqlCollection

  • Stops the specified SQL collection. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopSqlCollection API.

    Parameters

    Returns Promise<StopSqlCollectionResponse>

    StopSqlCollectionResponse

suspendWorkRequest

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SuspendWorkRequest API.

    Parameters

    Returns Promise<SuspendWorkRequestResponse>

    SuspendWorkRequestResponse

unsetSecurityAssessmentBaseline

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UnsetSecurityAssessmentBaseline API.

    Parameters

    Returns Promise<UnsetSecurityAssessmentBaselineResponse>

    UnsetSecurityAssessmentBaselineResponse

unsetUserAssessmentBaseline

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UnsetUserAssessmentBaseline API.

    Parameters

    Returns Promise<UnsetUserAssessmentBaselineResponse>

    UnsetUserAssessmentBaselineResponse

updateAlert

  • Updates the status of the specified alert. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAlert API.

    Parameters

    Returns Promise<UpdateAlertResponse>

    UpdateAlertResponse

updateAuditArchiveRetrieval

updateAuditPolicy

updateAuditProfile

  • Updates one or more attributes of the specified audit profile. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAuditProfile API.

    Parameters

    Returns Promise<UpdateAuditProfileResponse>

    UpdateAuditProfileResponse

updateAuditTrail

  • Updates one or more attributes of the specified audit trail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAuditTrail API.

    Parameters

    Returns Promise<UpdateAuditTrailResponse>

    UpdateAuditTrailResponse

updateDataSafePrivateEndpoint

updateDatabaseSecurityConfig

updateFinding

  • Updates one or more attributes of the specified finding. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateFinding API.

    Parameters

    Returns Promise<UpdateFindingResponse>

    UpdateFindingResponse

updateLibraryMaskingFormat

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateLibraryMaskingFormat API.

    Parameters

    Returns Promise<UpdateLibraryMaskingFormatResponse>

    UpdateLibraryMaskingFormatResponse

updateMaskingColumn

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMaskingColumn API.

    Parameters

    Returns Promise<UpdateMaskingColumnResponse>

    UpdateMaskingColumnResponse

updateMaskingPolicy

  • Updates one or more attributes of the specified masking policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMaskingPolicy API.

    Parameters

    Returns Promise<UpdateMaskingPolicyResponse>

    UpdateMaskingPolicyResponse

updateOnPremConnector

  • Updates one or more attributes of the specified on-premises connector. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateOnPremConnector API.

    Parameters

    Returns Promise<UpdateOnPremConnectorResponse>

    UpdateOnPremConnectorResponse

updateOnPremConnectorWallet

updatePeerTargetDatabase

  • Updates one or more attributes of the specified Data Safe peer target database. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePeerTargetDatabase API.

    Parameters

    Returns Promise<UpdatePeerTargetDatabaseResponse>

    UpdatePeerTargetDatabaseResponse

updateReport

  • Updates the specified report. Only tags can be updated. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateReport API.

    Parameters

    Returns Promise<UpdateReportResponse>

    UpdateReportResponse

updateReportDefinition

  • Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateReportDefinition API.

    Parameters

    Returns Promise<UpdateReportDefinitionResponse>

    UpdateReportDefinitionResponse

updateSdmMaskingPolicyDifference

updateSecurityAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSecurityAssessment API.

    Parameters

    Returns Promise<UpdateSecurityAssessmentResponse>

    UpdateSecurityAssessmentResponse

updateSecurityPolicy

updateSecurityPolicyDeployment

updateSensitiveColumn

  • Updates one or more attributes of the specified sensitive column. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSensitiveColumn API.

    Parameters

    Returns Promise<UpdateSensitiveColumnResponse>

    UpdateSensitiveColumnResponse

updateSensitiveDataModel

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSensitiveDataModel API.

    Parameters

    Returns Promise<UpdateSensitiveDataModelResponse>

    UpdateSensitiveDataModelResponse

updateSensitiveType

  • Updates one or more attributes of the specified sensitive type. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSensitiveType API.

    Parameters

    Returns Promise<UpdateSensitiveTypeResponse>

    UpdateSensitiveTypeResponse

updateSqlCollection

updateSqlFirewallPolicy

updateTargetAlertPolicyAssociation

updateTargetDatabase

  • Updates one or more attributes of the specified Data Safe target database. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTargetDatabase API.

    Parameters

    Returns Promise<UpdateTargetDatabaseResponse>

    UpdateTargetDatabaseResponse

updateUserAssessment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateUserAssessment API.

    Parameters

    Returns Promise<UpdateUserAssessmentResponse>

    UpdateUserAssessmentResponse

uploadMaskingPolicy

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UploadMaskingPolicy API.

    Parameters

    Returns Promise<UploadMaskingPolicyResponse>

    UploadMaskingPolicyResponse

uploadSensitiveDataModel

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UploadSensitiveDataModel API.

    Parameters

    Returns Promise<UploadSensitiveDataModelResponse>

    UploadSensitiveDataModelResponse