openapi: 3.2.0 info: description: APIs for using Oracle Data Safe. title: Data Safe API version: '20181201' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/9fcfdf5451ced20c250b00300ef33ea3d173d05dd0bb98b21348904f03d6ccc0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Safe API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/9fcfdf5451ced20c250b00300ef33ea3d173d05dd0bb98b21348904f03d6ccc0.yaml what: the harvested document for Data Safe API servers: - url: http://127.0.0.1/20181201 - url: https://127.0.0.1/20181201 tags: - name: dataSafe paths: /actions/downloadPrivilegeScript: post: description: 'Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database. ' operationId: DownloadPrivilegeScript parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The privilege script is downloaded successfully. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database. tags: - dataSafe x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/TargetDatabase' /alertAnalytics: get: description: 'Returns the aggregation details of the alerts. ' operationId: ListAlertAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/TimeStartQueryParam' - $ref: '#/components/parameters/TimeEndQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AlertSortByQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/AlertSCIMQueryParam' - $ref: '#/components/parameters/AlertSummaryFieldQueryParam' - $ref: '#/components/parameters/AlertGroupByQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A page of alerts aggregation objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the aggregation details of the alerts. tags: - dataSafe x-example: "GET /20181201/alertAnalytics?groupBy=targetId\n {\n \"items\": [\n { \"metricName\": \"POLICY_VIOLATIONS\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:40\",\n \"count\": 3,\n \"dimensions\": {\n \"targetName\": \"target_1\"\n }\n },\n { \"metricName\": \"HIGH_SEVERITY\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:00\",\n \"count\": 4,\n \"dimensions\": {\n \"targetName\": \"target_1\",\n \"operation\": \"alter system set sqlsecurity false\"\n }\n }\n ]\n }\n" x-related-resource: '#/definitions/AlertSummary' /alertPolicies: get: description: 'Gets a list of all alert policies. ' operationId: ListAlertPolicies parameters: - $ref: '#/components/parameters/AlertPolicyIdQueryParam' - $ref: '#/components/parameters/AlertPolicyTypeQueryParam' - $ref: '#/components/parameters/IsUserDefinedAlertPolicyQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AlertPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AlertPolicySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: Alert policies retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all alert policies. tags: - dataSafe x-example: 'GET /20181201/alertPolicies Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AlertPolicy' /alertPolicies/{alertPolicyId}: get: description: Gets the details of alert policy by its ID. operationId: GetAlertPolicy parameters: - $ref: '#/components/parameters/AlertPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Alert policy associated with the given OCID retrieved succesffully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified alert policy. tags: - dataSafe x-example: 'GET /20181201/alertPolicies/<alertPolicyId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /alertPolicies/{alertPolicyId}/rules: get: description: '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. ' operationId: ListAlertPolicyRules parameters: - $ref: '#/components/parameters/AlertPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Policy rules associated with the given OCID retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertPolicyRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the rules of the specified alert policy. tags: - dataSafe x-example: 'GET /20181201/alertPolicies/<alertPolicyId>/rules Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: downstream.fetcher().pathParams(request.resourceId).fetch('DataSafe', 'GetAlertPolicy').compartmentId != 'SEEDED_RESOURCE' x-related-resource: '#/definitions/AlertPolicy' /alerts: get: description: 'Gets a list of all alerts. ' operationId: ListAlerts parameters: - $ref: '#/components/parameters/AlertIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AlertSortByQueryParam' - $ref: '#/components/parameters/AlertSCIMQueryParam' - $ref: '#/components/parameters/AlertFieldQueryParam' responses: 200: description: Alerts retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all alerts. tags: - dataSafe x-example: 'GET /20181201/alerts Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AlertSummary' patch: description: Updates the status of one or more alert specified by the alert IDs. operationId: PatchAlerts parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 202: description: Request received successfully. The alerts will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patch alerts. tags: - dataSafe x-example: "PATCH /20181201/alerts?compartmentIdInSubtree=true&accessLevel=ACCESSIBLE\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\",\n \"items\":\n [\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?id=='ocid1.datasafealert.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokjwq']\",\n \"value\": {\"status\":\"CLOSED\"}\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?id=='ocid1.datasafealert.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yjvjgfd']\",\n \"value\": {\"status\":\"CLOSED\"}\n }\n ]\n}\n" x-related-resource: '#/definitions/Alert' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchAlertsDetails' description: The alert details to update the status of one or more alert specified by the alert IDs. required: true /alerts/actions/updateAll: post: description: Updates alerts in the specified compartment. operationId: AlertsUpdate parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 202: description: Request received successfully. The status of the alerts will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates alerts in the specified compartment. tags: - dataSafe x-example: "POST /20181201/alerts/actions/updateAll?compartmentIdInSubtree=true&accessLevel=ACCESSIBLE\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"status\" : \"OPEN\",\n \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\"\n}\n\nPOST /20181201/alerts/actions/updateAll\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"status\" : \"CLOSED\",\n \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\",\n \"targetId\":\"ocid1.datasafeinstance.target.dev2.arsgk6rrajbnicptestyf1a58zng0ukwarqeuedcuzdxy32gakkkuzesasew\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Alert' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertsUpdateDetails' description: The details to update the alerts in the specified compartment. required: true /alerts/{alertId}: get: description: Gets the details of the specified alerts. operationId: GetAlert parameters: - $ref: '#/components/parameters/AlertIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Alert associated with the given OCID is retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Alert' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified alerts. tags: - dataSafe x-example: 'GET /20181201/alerts/<alertId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the status of the specified alert. operationId: UpdateAlert parameters: - $ref: '#/components/parameters/AlertIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Alert updated successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Alert' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the status of the specified alert. tags: - dataSafe x-related-resource: '#/definitions/Alert' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAlertDetails' description: The details used to update alert status. required: true /alerts/{alertId}/actions/changeCompartment: post: description: Moves the specified alert into a different compartment. operationId: ChangeAlertCompartment parameters: - $ref: '#/components/parameters/AlertIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Alert moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the specified alert into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/Alert' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAlertCompartmentDetails' description: The details used to change the compartment of an alert. required: true /attributeSets: get: description: 'Retrieves the list of attribute sets. The ListAttributeSets operation returns only the attribute sets in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requester 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 ListAttributeSet 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. ' operationId: ListAttributeSets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AttributeSetIdQueryParam' - $ref: '#/components/parameters/AttributeSetTypeQueryParam' - $ref: '#/components/parameters/AttributeSetLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsUserDefinedAttributeSetQueryParam' - $ref: '#/components/parameters/InUseAttributeSetQueryParam' responses: 200: description: List of attribute set records retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-related-resource: '#/definitions/AttributeSet' content: application/json: schema: $ref: '#/components/schemas/AttributeSetCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the list of attribute sets. tags: - dataSafe x-example: 'GET /20181201/attributeSets Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/attributeSet' post: description: 'Creates an attribute set. ' operationId: CreateAttributeSet parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The attribute set is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AttributeSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an attribute set. tags: - dataSafe x-example: "POST /20181201/attributeSets\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"IP addresses - AttributeSet\",\n \"description\": \"Attribute set for IP addresses\",\n \"attributeSetType\" : \"IP_ADDRESS\"\n \"attributeSetValues\":[\"198.168.34.23\", \"198.168.34.23\"]\n \"freeformTags\" : {\n \"env\": \"dev\",\n \"val\": \"testing\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"use\": \"datasafe\"\n }\n }\n}\n" x-related-resource: '#/definitions/AttributeSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAttributeSetDetails' description: Details of an attribute set. required: true /attributeSets/{attributeSetId}: delete: description: 'Submits a work request to delete an attribute set. ' operationId: DeleteAttributeSet parameters: - $ref: '#/components/parameters/AttributeSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. attribute set will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Submits a work request to delete an attribute set. tags: - dataSafe x-example: 'DELETE /20181201/attributeSets/<attributeSetId> Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AttributeSet' get: description: Gets the details of the specified attribute set. operationId: GetAttributeSet parameters: - $ref: '#/components/parameters/AttributeSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Attribute set details retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AttributeSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified attribute set. tags: - dataSafe x-example: 'GET /20181201/attributeSets/<attributeSetId> Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates an attribute set. operationId: UpdateAttributeSet parameters: - $ref: '#/components/parameters/AttributeSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The attribute set will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates an attribute set. tags: - dataSafe x-example: "PUT /20181201/attributeSets/<attributeSetId>\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"IP addresses - AttributeSet\",\n \"description\": \"Attribute set for IP addresses\",\n \"attributeSetValues\": [\"198.168.34.23\",\"198.168.34.23\"],\n \"freeformTags\" : {\n \"env\": \"prod\",\n \"val\": \"testing\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"use\": \"data-audit\"\n }\n }\n}\n" x-related-resource: '#/definitions/AttributeSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAttributeSetDetails' description: Details to update an Attribute set. required: true /attributeSets/{attributeSetId}/actions/changeCompartment: post: description: 'Moves the attribute set to the specified compartment. When provided, if-Match is checked against ETag value of the resource. ' operationId: ChangeAttributeSetCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/AttributeSetIdPathParam' responses: 202: description: Accepted the request successfully. The attribute set will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the attribute set to the specified compartment. tags: - dataSafe x-example: "POST /20210414/attributeSets/<attributeSetId>/actions/changeCompartment\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AttributeSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAttributeSetCompartmentDetails' description: The details used to change the compartment of an attribute set. required: true /attributeSets/{attributeSetId}/associatedResources: get: description: Returns list of all associated resources. operationId: ListAssociatedResources parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/AttributeSetIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AttributeSetAssociatedResourceTypeQueryParam' - $ref: '#/components/parameters/AttributeSetAssociatedResourceIdQueryParam' responses: 200: description: List of all associated resources of an attribute set. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssociatedResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns list of all associated resources of the attribute set identified by the attribute set id passed as path parameter. tags: - dataSafe x-example: 'GET /20181201/attributeSets/<attributeSetId> Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AttributeSet' /auditArchiveRetrievals: get: description: 'Returns the list of audit archive retrieval. ' operationId: ListAuditArchiveRetrievals parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalIdQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalTargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalPaginationLimitQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalPaginationTokenQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalLifecycleStateQueryParam' - $ref: '#/components/parameters/ArchiveRetrievalTimeOfExpiryQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of archive retrieval records retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-related-resource: '#/definitions/AuditArchiveRetrieval' content: application/json: schema: $ref: '#/components/schemas/AuditArchiveRetrievalCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the list of audit archive retrieval. tags: - dataSafe x-example: 'GET /20181201/auditArchiveRetrievals Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditArchiveRetrieval' post: description: '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. ' operationId: CreateAuditArchiveRetrieval parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. Archival retreival process has started. This will usually take over an hour to complete. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditArchiveRetrieval' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a work request to retrieve archived audit data. tags: - dataSafe x-example: "POST /20181201/auditArchiveRetrievals\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaya6mse5a2dehjqkhdssanuv4h3bda5pkjcsplqnxgthttaarpdhq\",\n \"displayName\" : \"Archive retrieval 2021\",\n \"description\": \"Archive retrieval for target prod_dev from month Feb 2021 to May 2021\",\n \"targetId\": \"ocid1.datasafetargetdatabase.oc1.iad.abuwcljrfcr7ocbvkqt6ubk3ccgasaot7jorth4r2d3nl6guhrtawkytdynq\",\n \"startDate\": \"2021-02-01T00:00:00.000Z\",\n \"endDate\": \"2021-05-01T00:00:00.000Z\",\n \"freeformTags\" : {\n \"env\": \"dev\",\n \"val\": \"testing\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"use\": \"datasafe\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAuditArchiveRetrievalDetails' description: Details for creating retrieving archived audit data. required: true /auditArchiveRetrievals/{auditArchiveRetrievalId}: delete: description: 'To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId. ' operationId: DeleteAuditArchiveRetrieval parameters: - $ref: '#/components/parameters/ArchiveRetrievalIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Retrieved archive data will be unloaded to object storage. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Submits a work request to unload retrieved archive data. tags: - dataSafe x-example: 'DELETE /20181201/auditArchiveRetrievals/{auditArchiveRetrievalId} Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditArchiveRetrieval' get: description: Gets the details of the specified archive retreival. operationId: GetAuditArchiveRetrieval parameters: - $ref: '#/components/parameters/ArchiveRetrievalIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Archive retrieval details retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditArchiveRetrieval' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified archive retreival. tags: - dataSafe x-example: 'GET /20181201/auditArchiveRetrievals/<auditArchiveRetrievalId> Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the audit archive retrieval. operationId: UpdateAuditArchiveRetrieval parameters: - $ref: '#/components/parameters/ArchiveRetrievalIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The archive retrieval will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the audit archive retrieval. tags: - dataSafe x-example: "PUT /20181201/auditArchiveRetrievals/<auditArchiveRetrievalId>\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"updated-name\",\n \"description\" : \"updated-description\",\n \"freeformTags\" : {\n \"env\": \"prod\",\n \"val\": \"testing\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"use\": \"data-audit\"\n }\n }\n}\n" x-related-resource: '#/definitions/AuditArchiveRetrieval' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuditArchiveRetrievalDetails' description: Details to update the audit archive retrieval. required: true /auditArchiveRetrievals/{auditArchiveRetrievalId}/actions/changeCompartment: post: description: 'Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource. ' operationId: ChangeAuditArchiveRetrievalCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ArchiveRetrievalIdPathParam' responses: 202: description: Accepted the request successfully. The archive retrieval will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the archive retreival to the specified compartment. tags: - dataSafe x-example: "POST /20210414/auditArchiveRetrievals/<auditArchiveRetrievalId>/actions/changeCompartment\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaakytcpccnbfnbyuorvbmgvldjzcvlssmaxogjhhyocngbbbcllwyh\"\n}\n" x-related-resource: '#/definitions/AuditArchiveRetrieval' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAuditArchiveRetrievalCompartmentDetails' description: The details used to change the compartment of a archive retrieval. required: true /auditEventAnalytics: get: description: '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:** /auditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&scimQuery=(auditEventTime ge "2021-06-13T23:49:14") /auditEventAnalytics?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. /auditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned. ' operationId: ListAuditEventAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AuditEventPaginationLimitQueryParam' - $ref: '#/components/parameters/AuditEventPaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/EventSCIMQueryParam' - $ref: '#/components/parameters/summaryFieldQueryParam' - $ref: '#/components/parameters/TimeStartQueryParam' - $ref: '#/components/parameters/TimeEndQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' - $ref: '#/components/parameters/GroupByQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AuditEventSummarySortByQueryParam' responses: 200: description: Summary of audit events collected by Data Safe and analyzed using filters to show trends. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-example: "application-json: |\n{\n \"items\": [\n { \"metricName\": \"LOGIN_SUCCESSES\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:00\",\n \"count\": 3,\n \"dimensions\": {\n \"SECURED_TARGET_NAME\": \"src_5_30m5_t1_28061\",\n \"CLIENT_HOST_NAME\": \"jobsvm3002.jobsvm.stestvcn.oraclevcn.com\"\n }\n },\n { \"metricName\": \"RULE_VIOLATIONS\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:00\",\n \"count\": 4,\n \"dimensions\": {\n \"SECURED_TARGET_NAME\": \"src_5_30m5_t1_28061\",\n \"CLIENT_HOST_NAME\": \"jobsvm3002.jobsvm.stestvcn.oraclevcn.com\"\n }\n }\n ]\n}\n" content: application/json: schema: $ref: '#/components/schemas/AuditEventAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets summary of Data Safe audit events by time trends, target name, user name, client hostname and object type. tags: - dataSafe x-example: 'GET /20210518/auditEventAnalytics Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditEventSummary' /auditEvents: get: description: '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. ' operationId: ListAuditEvents parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/AuditEventPaginationLimitQueryParam' - $ref: '#/components/parameters/AuditEventPaginationTokenQueryParam' - $ref: '#/components/parameters/EventSCIMQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AuditEventSortByQueryParam' responses: 200: description: A list of Data Safe audit events retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-example: "application-json: |\n {\n \"items\": [\n {\n \"id\":\"ocid1.auditevent.oc1..aaaaaaaaiu6b5x762v2un36ubxhzhoqyd5a6tfu4ny3su6g5xjtvnlomlyrq810\",\n \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaya6mse5a2dehjqkhdssanuv4h3bda5pkjcsplqnxgthttaarpdhq\",\n \"dbUserName\":\"ACSAGENT\",\n \"targetId\":\"ocid1.datasafetargetdatabase.oc1.iad.abuwcljryydht2vpbko6kezmcx7p2nrlx2e2c3jxtr24czsz4ofzojyxn5rt\",\n \"databaseType\":\"Oracle Cloud Database\",\n \"targetName\":\"src_5_30m5_t1_28061\",\n \"targetClass\":\"ORACLE_DATABASE\",\n \"auditEventTime\":\"2021-07-02T12:42:58\",\n \"timeCollected\":\"2021-07-08T14:22:12\",\n \"osUserName\":\"dscs\",\n \"operation\":\"SELECT\",\n \"operationStatus\":\"SUCCESS\",\n \"eventName\":\"SELECT\",\n \"objectType\":\"UNIFIED_AUDIT_TRAIL\",\n \"objectOwner\":\"AUDSYS\",\n \"clientHostname\":\"jobsvm3002.jobsvm.stestvcn.oraclevcn.com\",\n \"clientIp\":\"10.0.4.15\",\n \"isAlerted\":false,\n \"clientProgram\":\"JDBC Thin Client\",\n \"commandText\":\"SELECT * FROM AUDSYS.UNIFIED_AUDIT_TRAIL WHERE \\\"EVENT_TIMESTAMP\\\"<=:1 AND \\\"EVENT_TIMESTAMP\\\">:2 \\u0000\",\n \"commandParam\":\" #1(31):02-JUL-21 12.42.15.044000000 PM #2(31):02-JUL-21 12.34.22.509000000 PM\",\n \"extendedEventAttributes\":\"PROXY_SESSIONID=0::INSTANCE_ID=1::SESSIONID=2474754514::AUTHENTICATION_TYPE=(TYPE=(DATABASE));(CLIENT ADDRESS=((ADDRESS=(PROTOCOL=tcp)(HOST=10.0.4.15)(PORT=6060))));::DBID=2877711343::DBPROXY_USERNAME=null::EXTERNAL_USERID=null::GLOBAL_USERID=null::DBLINK_INFO=null::STATEMENT_ID=376::OS_PROCESS=21886::TRANSACTION_ID=08001A0049290000::SCN=16279415167744::EXECUTION_ID=null::OBJECT_SCHEMA=AUDSYS::APPLICATION_CONTEXTS=null::NEW_SCHEMA=null::NEW_NAME=null::OBJECT_EDITION=null::SYSTEM_PRIVILEGE_USED=null::SYSTEM_PRIVILEGE=null::AUDIT_OPTION=null::OBJECT_PRIVILEGES=null::ROLE=null::TARGET_USER=null::EXCLUDED_USER=null::EXCLUDED_SCHEMA=null::EXCLUDED_OBJECT=null::ADDITIONAL_INFO=null::DIRECT_PATH_NUM_COLUMNS_LOADED=null::CURRENT_USER=ACSAGENT::KSACL_USER_NAME=null::KSACL_SERVICE_NAME=null::KSACL_SOURCE_LOCATION=null\",\n \"auditLocation\":\"Audit Table\",\n \"osTerminal\":\"unknown\",\n \"clientId\":\"ORACLE$_DATA_SAFE#\",\n \"auditType\":\"STANDARD\"\n }\n ]\n }\n" content: application/json: schema: $ref: '#/components/schemas/AuditEventCollection' application/xml: schema: $ref: '#/components/schemas/AuditEventCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of Data Safe audit Events collected from the target database. tags: - dataSafe x-example: 'GET /20210518/auditEvents Host: datasafe.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditEventSummary' /auditPolicies: get: description: '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. ' operationId: ListAuditPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/AuditPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/AuditPolicyIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit policies retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all audit policies. tags: - dataSafe x-example: 'GET /20181201/auditPolicies Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /auditPolicies/{auditPolicyId}: get: description: Gets a audit policy by identifier. operationId: GetAuditPolicy parameters: - $ref: '#/components/parameters/AuditPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit policy retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a audit policy by identifier. tags: - dataSafe x-example: 'GET /20181201/auditPolicies/{auditPolicyId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the audit policy. operationId: UpdateAuditPolicy parameters: - $ref: '#/components/parameters/AuditPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the audit policy. tags: - dataSafe x-example: "PUT /20181201/auditPolicies/{auditPolicyId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"AuditPolicy_HRandPayrollTarget\",\n \"description\" : \"Target database for HR and Payroll combined\"\n}\n" x-related-resource: '#/definitions/AuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuditPolicyDetails' description: Details to update the audit policy. required: true /auditPolicies/{auditPolicyId}/actions/changeCompartment: post: description: Moves the specified audit policy and its dependent resources into a different compartment. operationId: ChangeAuditPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/AuditPolicyIdPathParam' responses: 202: description: Request received successfully. The audit policy will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves the specified audit policy and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/auditPolicies/{auditPolicyId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAuditPolicyCompartmentDetails' description: Details for the compartment move. required: true /auditPolicies/{auditPolicyId}/actions/provision: post: description: Provision audit policy. operationId: ProvisionAuditPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/AuditPolicyIdPathParam' responses: 202: description: Request received successfully. The audit policy will be provisioned to the source target database. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Provision audit policy. tags: - dataSafe x-example: "POST /20160918/auditPolicies/{auditPolicyId}/actions/provision\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"isDataSafeServiceAccountExcluded\" : false,\n \"provisionAuditConditions\" : [\n {\n \"auditPolicyName\" : \"ORA_ACCOUNT_MGMT\",\n \"isPrivUsersManagedByDataSafe\" : false,\n \"isEnabled\" : true,\n \"enableConditions\" : [{\n \"entitySelection\" : \"INCLUDE\",\n \"entityType\" : \"USER\",\n \"operationStatus\" : \"SUCCESS\",\n \"entityNames\" : [\"SCOTT\", \"MIKE\"]\n },\n {\n \"entitySelection\" : \"INCLUDE\",\n \"entityType\" : \"ROLE\",\n \"operationStatus\" : \"SUCCESS\",\n \"entityNames\" : [\"HR_ADMIN_ROLE\"]\n }]\n },\n {\n \"auditPolicyName\" : \"Critical Database Activity\",\n \"isDataSafeManagedPrivUsers\" : false,\n \"isEnabled\" : false\n }]\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProvisionAuditPolicyDetails' description: Details for provisioning the given policies on the source target database. required: true /auditPolicies/{auditPolicyId}/actions/retrieveFromTarget: post: description: Retrieves the audit policy details from the source target database. operationId: RetrieveAuditPolicies parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/AuditPolicyIdPathParam' responses: 202: description: Request received successfully. The Audit Policies will be retrieved from the source target database. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Retrieves the audit policy details from the source target database. tags: - dataSafe x-example: 'POST /20160918/auditPolicies/{auditPolicyId}/actions/retrieveFromTarget Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AuditPolicy' /auditPolicyAnalytics: get: description: '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 ' operationId: ListAuditPolicyAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AuditPolicyGroupByQueryParam' - $ref: '#/components/parameters/AuditPolicyCategoryQueryParam' - $ref: '#/components/parameters/AuditPolicyNameQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/AuditPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully summarized audit policy information. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditPolicyAnalyticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarizes the audit policy information. tags: - dataSafe x-example: 'GET /20181201/auditPolicyAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /auditProfileAnalytics: get: description: '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. ' operationId: ListAuditProfileAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AuditProfileGroupByQueryParam' - $ref: '#/components/parameters/AuditProfileTargetTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully summarized audit profile information. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditProfileAnalyticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarizes audit profile information. tags: - dataSafe /auditProfiles: get: description: '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. ' operationId: ListAuditProfiles parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/AuditProfileIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/AuditProfileTargetTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AuditProfileLifecycleStateQueryParam' - $ref: '#/components/parameters/IsOverrideGlobalRetentionSettingQueryParam' - $ref: '#/components/parameters/IsPaidUsageEnabledQueryParam' - $ref: '#/components/parameters/AuditCollectedVolumeGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit profiles retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditProfileCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all audit profiles. tags: - dataSafe x-example: 'GET /20181201/auditProfiles Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditProfile' post: description: Create a new audit profile resource. operationId: CreateAuditProfile parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The audit profile is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'Full URI of the created audit profile. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditProfile' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a new audit profile resource. tags: - dataSafe x-example: "POST /20181201/auditProfiles\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers><authorization and other headers> ' put: description: Updates one or more attributes of the specified audit profile. operationId: UpdateAuditProfile parameters: - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit profile will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified audit profile. tags: - dataSafe x-example: "PUT /20181201/auditProfiles/{auditProfileId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"Audit_updated\",\n \"description\" : \"updated-description\"\n}\n" x-related-resource: '#/definitions/AuditProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuditProfileDetails' description: The information to be updated. required: true /auditProfiles/{auditProfileId}/actions/calculateAuditVolumeAvailable: post: description: 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. operationId: CalculateAuditVolumeAvailable parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuditProfileIdPathParam' responses: 202: description: Request received successfully. The volume of audit events available on the target database will be calculated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Calculates the audit data volume available on target. tags: - dataSafe x-example: "POST /20160918/auditProfiles/<auditProfileId>/actions/calculateAuditVolumeAvailable\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"trailLocations\" : [\"SYS.FGA_LOG$\", \"SYS.AUD$\"],\n \"auditCollectionStartTime\" : \"17-05-2021T15:05:28Z\"\n}\n" x-related-resource: '#/definitions/AuditProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/CalculateAuditVolumeAvailableDetails' description: Details for the calculation of audit volume available on target database. required: true /auditProfiles/{auditProfileId}/actions/calculateAuditVolumeCollected: post: description: Calculates the volume of audit events collected by data safe. operationId: CalculateAuditVolumeCollected parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuditProfileIdPathParam' responses: 202: description: Request received successfully. The volume of audit events collected by data safe will be calculated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Calculates the audit data collected by data safe. tags: - dataSafe x-example: "POST /20160918/auditProfiles/<auditProfileId>/actions/calculateAuditVolumeCollected\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"timeFromMonth\" : \"01-05-2021T00:00:00Z\",\n \"timeToMonth\" : \"01-12-2021T00:00:00Z\"\n}\n" x-related-resource: '#/definitions/AuditProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/CalculateAuditVolumeCollectedDetails' description: Details for the calculation of audit volume collected by data safe. required: true /auditProfiles/{auditProfileId}/actions/changeCompartment: post: description: Moves the specified audit profile and its dependent resources into a different compartment. operationId: ChangeAuditProfileCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuditProfileIdPathParam' responses: 202: description: Request received successfully. The audit profile will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified audit profile and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/auditProfiles/<auditProfileId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AuditProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAuditProfileCompartmentDetails' description: Details for the compartment move. required: true /auditProfiles/{auditProfileId}/actions/changeRetention: post: description: Change the online and offline months . operationId: ChangeRetention parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The audit profile will be updated with retention settings. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Change the online and offline months . tags: - dataSafe x-example: "POST /20160918/auditProfiles/<auditProfileId>/actions/changeRetention\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"onlineMonths\" : \"10\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AuditProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRetentionDetails' description: Details for the audit retention months to be modified. required: true /auditProfiles/{auditProfileId}/actions/discoverAuditTrails: post: description: '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. ' operationId: DiscoverAuditTrails parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The audit trails for the audit profile resource will be discovered. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Updates the list of audit trails created under audit profile. tags: - dataSafe x-related-resource: '#/definitions/AuditProfile' /auditProfiles/{auditProfileId}/availableAuditVolumes: get: description: Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date. operationId: ListAvailableAuditVolumes parameters: - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/TrailLocationQueryParam' - $ref: '#/components/parameters/MonthInConsiderationGreaterThanQueryParam' - $ref: '#/components/parameters/MonthInConsiderationLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AvailableAuditVolumeSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit volume for each audit trail retrieved from source database successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AvailableAuditVolumeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all data points for the audit volume available on target database. tags: - dataSafe x-example: 'GET /20181201/auditProfiles/{auditProfileId}/availableAuditVolumes Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditProfile' /auditProfiles/{auditProfileId}/collectedAuditVolumes: get: description: Gets a list of all collected audit volume data points. operationId: ListCollectedAuditVolumes parameters: - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/MonthInConsiderationGreaterThanQueryParam' - $ref: '#/components/parameters/MonthInConsiderationLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CollectedAuditVolumeSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit volume of the audit profile collected by Data Safe, and stored online or in object store retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CollectedAuditVolumeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all collected audit volume data points. tags: - dataSafe x-example: 'GET /20181201/auditProfiles/{auditProfileId}/collectedAuditVolumes Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditProfile' /auditProfiles/{auditProfileId}/targetOverrides: get: description: Gets a list of all targets whose audit settings override the target group setting. operationId: ListTargetOverrides parameters: - $ref: '#/components/parameters/AuditProfileIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of targets whose retention settings override target group audit profile settings retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetOverrideCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of targets with their audit profiles and retention settings that override the target group setting. tags: - dataSafe x-example: 'GET /20181201/auditProfiles/{auditProfileId}/targetOverrides Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditProfile' /auditTrailAnalytics: get: description: '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. ' operationId: ListAuditTrailAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AuditTrailGroupByQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TimeStartQueryParam' - $ref: '#/components/parameters/TimeEndQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully summarized audit trail information. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditTrailAnalyticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarizes audit trail information. tags: - dataSafe /auditTrails: get: description: '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. ' operationId: ListAuditTrails parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/AuditTrailIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AuditTrailLifecycleStateQueryParam' - $ref: '#/components/parameters/AuditTrailStatusQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit trails retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditTrailCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all audit trails. tags: - dataSafe x-example: 'GET /20181201/auditProfiles/{auditProfileId}/auditTrails Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AuditTrail' /auditTrails/{auditTrailId}: delete: description: Deletes the specified audit trail. operationId: DeleteAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit trail will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified audit trail . tags: - dataSafe x-related-resource: '#/definitions/AuditTrail' get: description: Gets the details of audit trail. operationId: GetAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Audit trail retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AuditTrail' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the details of audit trail. tags: - dataSafe x-example: 'GET /20181201/auditTrails/{auditTrailId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates one or more attributes of the specified audit trail. operationId: UpdateAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit trail will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified audit trail. tags: - dataSafe x-example: "PUT /20181201/auditTrails/{auditTrailId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"updated-name\",\n \"description\" : \"updated-description\",\n \"isAutoPurgeEnabled\" : false\n}\n" x-related-resource: '#/definitions/AuditTrail' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuditTrailDetails' description: The information to be updated. required: true /auditTrails/{auditTrailId}/actions/resume: post: description: Resumes the specified audit trail once it got stopped. operationId: ResumeAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit trail will be resumed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Resumes the specified audit trail once it got stopped. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AuditTrail' /auditTrails/{auditTrailId}/actions/start: post: description: Starts collection of audit records on the specified audit trail. operationId: StartAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The audit trail will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Starts collection of audit records on the specified audit trail. tags: - dataSafe x-example: "POST /20160918/auditTrails/{auditTrailId}/actions/start\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"timeStartCollection\" : \"2020-10-01T19:37:47.375Z\",\n \"isAutoPurgeEnabled\" : true\n}\n" x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/AuditTrail' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartAuditTrailDetails' description: Details for the starting audit. required: true /auditTrails/{auditTrailId}/actions/stop: post: description: Stops the specified audit trail. operationId: StopAuditTrail parameters: - $ref: '#/components/parameters/AuditTrailIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The audit trail will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Stops the specified audit trail. tags: - dataSafe x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/AuditTrail' /compatibleFormatsForDataTypes: get: description: '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 ' operationId: GetCompatibleFormatsForDataTypes parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of basic masking formats compatible with the supported data types retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompatibleFormatsForDataTypes' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of basic masking formats compatible with the supported data types. tags: - dataSafe x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/MaskingColumn' /compatibleFormatsForSensitiveTypes: get: description: '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. ' operationId: GetCompatibleFormatsForSensitiveTypes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of library masking formats compatible with the existing sensitive types retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompatibleFormatsForSensitiveTypes' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of library masking formats compatible with the existing sensitive types. tags: - dataSafe x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/MaskingColumn' /configuration: get: description: Gets the details of the Data Safe configuration. operationId: GetDataSafeConfiguration parameters: - $ref: '#/components/parameters/OptionalRootCompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Data Safe configuration retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSafeConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the Data Safe configuration. tags: - dataSafe x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/DataSafeConfiguration' put: description: 'Enables Data Safe in the tenancy and region. ' operationId: EnableDataSafeConfiguration parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Data Safe will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Enables Data Safe in the tenancy and region. tags: - dataSafe x-related-resource: '#/definitions/DataSafeConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableDataSafeConfigurationDetails' description: The details used to enable Data Safe. required: true /configuration/{compartmentId}/actions/modifyGlobalSettings: post: description: 'Modifies Global Settings in Data Safe in the tenancy and region. ' operationId: ModifyGlobalSettings parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CompartmentIdentifierPathParam' responses: 202: description: Request received successfully. Data Safe global settings will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Modifies Global Settings in Data Safe in the tenancy and region. tags: - dataSafe x-related-resource: '#/definitions/DataSafeConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ModifyGlobalSettingsDetails' description: The details used to update global settings in Data Safe. required: true /dataSafePrivateEndpoints: get: description: 'Gets a list of Data Safe private endpoints. ' operationId: ListDataSafePrivateEndpoints parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/VcnIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: Data Safe private endpoints retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DataSafePrivateEndpointSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of Data Safe private endpoints. tags: - dataSafe post: description: 'Creates a new Data Safe private endpoint. ' operationId: CreateDataSafePrivateEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The Data Safe private endpoint will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the Data Safe private endpoint. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSafePrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Data Safe private endpoint. tags: - dataSafe x-related-resource: '#/definitions/DataSafePrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataSafePrivateEndpointDetails' description: Details to create a new private endpoint. required: true /dataSafePrivateEndpoints/{dataSafePrivateEndpointId}: delete: description: Deletes the specified Data Safe private endpoint. operationId: DeleteDataSafePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSafePrivateEndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Data Safe private endpoint will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 204: description: Request received successfully. The Data Safe private endpoint will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified Data Safe private endpoint. tags: - dataSafe x-related-resource: '#/definitions/DataSafePrivateEndpoint' get: description: Gets the details of the specified Data Safe private endpoint. operationId: GetDataSafePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSafePrivateEndpointIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Data Safe private endpoint retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataSafePrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified Data Safe private endpoint. tags: - dataSafe put: description: Updates one or more attributes of the specified Data Safe private endpoint. operationId: UpdateDataSafePrivateEndpoint parameters: - $ref: '#/components/parameters/DataSafePrivateEndpointIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Data Safe private endpoint will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified Data Safe private endpoint. tags: - dataSafe x-related-resource: '#/definitions/DataSafePrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataSafePrivateEndpointDetails' description: The details used to update a Data Safe private endpoint. required: true /dataSafePrivateEndpoints/{dataSafePrivateEndpointId}/actions/changeCompartment: post: description: Moves the Data Safe private endpoint and its dependent resources to the specified compartment. operationId: ChangeDataSafePrivateEndpointCompartment parameters: - $ref: '#/components/parameters/DataSafePrivateEndpointIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The Data Safe private endpoint compartment will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' tags: - dataSafe x-related-resource: '#/definitions/DataSafePrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataSafePrivateEndpointCompartmentDetails' description: The details used to change the compartment of a Data Safe private endpoint. required: true /databaseSecurityConfigs: get: description: '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. ' operationId: ListDatabaseSecurityConfigs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DatabaseSecurityConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DatabaseSecurityConfigIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database security configurations retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseSecurityConfigCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all database security configurations. tags: - dataSafe x-example: 'GET /20181201/databaseSecurityConfigs Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /databaseSecurityConfigs/{databaseSecurityConfigId}: get: description: Gets a database security configuration by identifier. operationId: GetDatabaseSecurityConfig parameters: - $ref: '#/components/parameters/DatabaseSecurityConfigIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database security configuration retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseSecurityConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a database security configuration by identifier. tags: - dataSafe x-example: 'GET /20181201/databaseSecurityConfigs/{databaseSecurityConfigId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the database security configuration. operationId: UpdateDatabaseSecurityConfig parameters: - $ref: '#/components/parameters/DatabaseSecurityConfigIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The database security configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the database security configuration. tags: - dataSafe x-example: "PUT /20181201/databaseSecurityConfigs/{databaseSecurityConfigId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"DatabaseSecurityConfig_updated\",\n \"description\" : \"Updated database security configuration description\"\n \"sqlFirewallConfig\": {\n \"status\": \"ENABLED\",\n \"violationLogAutoPurge\": \"ENABLED\",\n \"excludeJob\": \"EXCLUDED\"\n }\n}\n" x-related-resource: '#/definitions/DatabaseSecurityConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabaseSecurityConfigDetails' description: Details to update the database security configuration. required: true /databaseSecurityConfigs/{databaseSecurityConfigId}/actions/changeCompartment: post: description: Moves the specified database security configuration and its dependent resources into a different compartment. operationId: ChangeDatabaseSecurityConfigCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/DatabaseSecurityConfigIdPathParam' responses: 202: description: Request received successfully. The database security configuration will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified database security configuration and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/DatabaseSecurityConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDatabaseSecurityConfigCompartmentDetails' description: Details for the compartment move. required: true /databaseSecurityConfigs/{databaseSecurityConfigId}/actions/refresh: post: description: Refreshes the specified database security configuration. operationId: RefreshDatabaseSecurityConfiguration parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/DatabaseSecurityConfigIdPathParam' responses: 202: description: Request received successfully. The database security configuration will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refreshes the specified database security configuration. tags: - dataSafe x-example: 'POST /20160918/databaseSecurityConfigs/{databaseSecurityConfigId}/actions/refresh Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DatabaseSecurityConfig' /discoveryAnalytics: get: description: '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. ' operationId: ListDiscoveryAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/DiscoveryAnalyticsGroupBy' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/DiscoveryAnalyticsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsCommonSensitiveTypeQueryParam' - $ref: '#/components/parameters/SensitiveTypeGroupIdQueryParam' responses: 200: description: Discovery analytics data retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets consolidated discovery analytics data based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' /discoveryJobs: get: description: Gets a list of incremental discovery jobs based on the specified query parameters. operationId: ListDiscoveryJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DiscoveryJobIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/DiscoveryLifecycleStateQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DiscoveryJobSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Discovery jobs retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryJobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of incremental discovery jobs based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/DiscoveryJob' post: description: '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. ' operationId: CreateDiscoveryJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. Incremental data discovery is being performed. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the data discovery job. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. tags: - dataSafe requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDiscoveryJobDetails' description: The details used to run an incremental data discovery job required: true /discoveryJobs/{discoveryJobId}: delete: description: Deletes the specified discovery job. operationId: DeleteDiscoveryJob parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The discovery job will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified discovery job. tags: - dataSafe x-related-resource: '#/definitions/DiscoveryJob' get: description: Gets the details of the specified discovery job. operationId: GetDiscoveryJob parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Discovery job retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified discovery job. tags: - dataSafe /discoveryJobs/{discoveryJobId}/actions/changeCompartment: post: description: Moves the specified discovery job and its dependent resources into a different compartment. operationId: ChangeDiscoveryJobCompartment parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Moves the discovery job to the given compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified discovery job and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/DiscoveryJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDiscoveryJobCompartmentDetails' description: The details used to change the compartment of a resource. required: true /discoveryJobs/{discoveryJobId}/results: get: description: Gets a list of discovery results based on the specified query parameters. operationId: ListDiscoveryJobResults parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/DiscoveryTypeQueryParam' - $ref: '#/components/parameters/PlannedActionQueryParam' - $ref: '#/components/parameters/IsResultAppliedQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DiscoveryResultSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Discovery results retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryJobResultCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of discovery results based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/DiscoveryJob' patch: description: '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. ' operationId: PatchDiscoveryJobResults parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The discovery results will be patched. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more discovery results. tags: - dataSafe x-example: "PATCH /discoveryJobs/ocid1.discoveryjob.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/results {\n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[*]\", \n \"value\": {\n \"plannedAction\":\"ACCEPT\"\n }\n }]\n} \nPATCH /discoveryJobs/ocid1.discoveryjob.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/results {\n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[?discoveryType=='NEW']\", \n \"value\": {\n \"plannedAction\":\"ACCEPT\"}\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='21']\", \n \"value\": {\n \"plannedAction\":\"INVALIDATE\"\n }\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?discoveryType=='MODIFIED']\", \n \"value\":{\n \"plannedAction\":\"ACCEPT\"\n }\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?discoveryType=='MISSING']\", \n \"value\": {\n \"plannedAction\":\"ACCEPT\"\n }\n }\n ]\n}\n" x-related-resource: '#/definitions/DiscoveryJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDiscoveryJobResultDetails' description: Details to patch discovery results. required: true /discoveryJobs/{discoveryJobId}/results/{resultKey}: delete: description: Deletes the specified discovery result. operationId: DeleteDiscoveryJobResult parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/ResultKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Discovery result deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified discovery result. tags: - dataSafe x-related-resource: '#/definitions/DiscoveryJobResult' get: description: Gets the details of the specified discovery result. operationId: GetDiscoveryJobResult parameters: - $ref: '#/components/parameters/DiscoveryJobIdPathParam' - $ref: '#/components/parameters/ResultKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Discovery result retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiscoveryJobResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified discovery result. tags: - dataSafe /libraryMaskingFormats: get: description: 'Gets a list of library masking formats based on the specified query parameters. ' operationId: ListLibraryMaskingFormats parameters: - $ref: '#/components/parameters/LibraryMaskingFormatIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MaskingLifecycleStateQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/LibraryMaskingFormatSourceQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/LibraryMaskingFormatSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Library masking formats retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LibraryMaskingFormatCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of library masking formats based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormatSummary' post: description: '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. ' operationId: CreateLibraryMaskingFormat parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The library masking format is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The URI of the library masking format. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LibraryMaskingFormat' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new library masking format. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormat' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLibraryMaskingFormatDetails' description: Details to create a new library masking format. required: true /libraryMaskingFormats/{libraryMaskingFormatId}: delete: description: Deletes the specified library masking format. operationId: DeleteLibraryMaskingFormat parameters: - $ref: '#/components/parameters/libraryMaskingFormatIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Library masking format deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified library masking format. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormat' get: description: Gets the details of the specified library masking format. operationId: GetLibraryMaskingFormat parameters: - $ref: '#/components/parameters/libraryMaskingFormatIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Library masking format retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LibraryMaskingFormat' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified library masking format. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormat' put: description: 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. operationId: UpdateLibraryMaskingFormat parameters: - $ref: '#/components/parameters/libraryMaskingFormatIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The library masking format will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified library masking format. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormat' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLibraryMaskingFormatDetails' description: Details to update a library masking format. required: true /libraryMaskingFormats/{libraryMaskingFormatId}/actions/changeCompartment: post: description: Moves the specified library masking format into a different compartment. operationId: ChangeLibraryMaskingFormatCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/libraryMaskingFormatIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Library masking format moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves the specified library masking format into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/LibraryMaskingFormat' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLibraryMaskingFormatCompartmentDetails' description: Details to change the compartment of a library masking format. required: true /maskingAnalytics: get: description: '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. ' operationId: ListMaskingAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/MaskingAnalyticsGroupBy' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/MaskingPolicyIdQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/MaskingAnalyticsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking analytics data retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets consolidated masking analytics data based on the specified query parameters. tags: - dataSafe x-example: "GET /20181201/maskingAnalytics?groupBy=targetIdAndPolicyId\n{ \"items\": [\n { \"metricName\": \"MASKING_POLICY\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\", \"sensitiveTypeId\": \"s1\" ,\"policyId\": \"p1\"}, \"count\":1},\n { \"metricName\": \"MASKING_DATABASE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\", \"sensitiveTypeId\": \"s1\",\"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SCHEMA\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s1\" , \"policyId\": \"p1\"}, \"count\": 980}\n\n { \"metricName\": \"MASKING_POLICY\", \"timeLastMasked\": \"\" \"dimensions\": { \"targetId\": \"t1\", \"sensitiveTypeId\": \"s2\" ,\"policyId\": \"p1\"}, \"count\":1},\n { \"metricName\": \"MASKING_DATABASE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\", \"sensitiveTypeId\": \"s2\",\"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SCHEMA\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"timeLastMasked\": \"\", \"dimensions\": { \"targetId\": \"t1\",\"sensitiveTypeId\": \"s2\" , \"policyId\": \"p1\"}, \"count\": 980}\n] }\nGET /20181201/maskingAnalytics?groupBy=targetIdAndPolicyId\n{ \"items\": [\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 7},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 9},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 47},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 35},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 3600},\n\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 3},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 14},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 6},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 35},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 50},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p2\" }, \"count\": 600},\n\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": { \"targetId\": \"t1\", \"policyId\": \"p1\" }, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 2},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 6},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"targetId\": \"t2\", \"policyId\": \"p3\" }, \"count\": 980}\n] }\nGET /20181201/maskingAnalytics?groupBy=policyId\n{ \"items\": [\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"policyId\": \"p1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\",\"dimensions\": { \"policyId\": \"p1\"}, \"count\": 2},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"policyId\": \"p1\"}, \"count\": 7},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"policyId\": \"p1\"}, \"count\": 9},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"policyId\": \"p1\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"policyId\": \"p1\"}, \"count\": 17},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"policyId\": \"p1\"}, \"count\": 35},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"policyId\": \"p1\"}, \"count\": 3600},\n\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"policyId\": \"p2\" }, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\",\"dimensions\": { \"policyId\": \"p1\"}, \"count\": 1}\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"policyId\": \"p2\" }, \"count\": 3},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"policyId\": \"p2\" }, \"count\": 14},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"policyId\": \"p2\" }, \"count\": 6},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"policyId\": \"p2\" }, \"count\": 35},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"policyId\": \"p2\" }, \"count\": 50},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"policyId\": \"p2\" }, \"count\": 600}\n}\nGET /maskingAnalytics?groupBy=targetId\n{ \"items\": [\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 2},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"targetId\": \"t1\"}, \"count\": 10},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"targetId\": \"t1\"}, \"count\": 20},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 10},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 73},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 37},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 4200},\n\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": { \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": { \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\",\"dimensions\": { \"targetId\": \"t2\"}, \"count\": 2},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\",\"dimensions\": { \"targetId\": \"t2\"}, \"count\": 6},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": { \"targetId\": \"t2\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": { \"targetId\": \"t2\"}, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": { \"targetId\": \"t2\"}, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": { \"targetId\": \"t2\"}, \"count\": 980},\n] }\nGET /20181201/maskingAnalytics?groupBy=sensitiveTypeId\n{ \"items\": [\n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\":2},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 2},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": {\"sensitiveTypeId\": \"s1\"}, \"count\": 980}\n \n { \"metricName\": \"MASKING_POLICY\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\":1},\n { \"metricName\": \"MASKING_DATABASE\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 1},\n { \"metricName\": \"MASKING_WORK_REQUEST\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SENSITIVE_TYPE\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 1},\n { \"metricName\": \"MASKED_SCHEMA\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 5},\n { \"metricName\": \"MASKED_TABLE\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 56},\n { \"metricName\": \"MASKED_COLUMN\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 89},\n { \"metricName\": \"MASKED_DATA_VALUE\", \"dimensions\": {\"sensitiveTypeId\": \"s2\"}, \"count\": 980}\n] }\n" x-related-resource: '#/definitions/MaskingPolicy' /maskingPolicies: get: description: Gets a list of masking policies based on the specified query parameters. operationId: ListMaskingPolicies parameters: - $ref: '#/components/parameters/MaskingPolicyIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MaskingLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskingPolicySortByQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking policies retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking policies based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' post: description: '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. ' operationId: CreateMaskingPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The masking policy is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The URI of the masking policy. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMaskingPolicyDetails' description: Details to create a new masking policy. required: true /maskingPolicies/{maskingPolicyId}: delete: description: Deletes the specified masking policy. operationId: DeleteMaskingPolicy parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' get: description: Gets the details of the specified masking policy. operationId: GetMaskingPolicy parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking policy retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified masking policy. tags: - dataSafe put: description: Updates one or more attributes of the specified masking policy. operationId: UpdateMaskingPolicy parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaskingPolicyDetails' description: Details to update a masking policy. required: true /maskingPolicies/{maskingPolicyId}/actions/addMaskingColumnsFromSdm: post: description: '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. ' operationId: AddMaskingColumnsFromSdm parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Columns will be added to the masking policy from the associated sensitive data model. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Adds columns to the specified masking policy from the associated sensitive data model. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MaskingPolicy' /maskingPolicies/{maskingPolicyId}/actions/changeCompartment: post: description: Moves the specified masking policy and its dependent resources into a different compartment. operationId: ChangeMaskingPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Masking policy moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified masking policy and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMaskingPolicyCompartmentDetails' description: Details to change the compartment of a masking policy. required: true /maskingPolicies/{maskingPolicyId}/actions/download: post: description: '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. ' operationId: DownloadMaskingPolicy parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking policy downloaded successfully. headers: content-length: description: The size of the masking policy file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Downloads an already-generated file corresponding to the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadMaskingPolicyDetails' description: Details to download a masking policy file. required: true /maskingPolicies/{maskingPolicyId}/actions/downloadLog: post: description: Downloads the masking log generated by the last masking operation on a target database using the specified masking policy. operationId: DownloadMaskingLog parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking log downloaded successfully. headers: content-length: description: The size of the masking log. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Downloads masking log. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadMaskingLogDetails' description: Details to download masking log. required: true /maskingPolicies/{maskingPolicyId}/actions/downloadReport: post: description: '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. ' operationId: DownloadMaskingReport parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking report downloaded successfully. headers: content-length: description: The size of the masking report file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Downloads an already-generated masking report. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadMaskingReportDetails' description: Details to download a masking report. required: true /maskingPolicies/{maskingPolicyId}/actions/generateHealthReport: post: description: Performs health check on the masking policy. operationId: GenerateHealthReport parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The masking policy health check will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Performs health check. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MaskingPolicyHealthReport' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateHealthReportDetails' description: Details to perform an health check. required: true /maskingPolicies/{maskingPolicyId}/actions/generatePolicyForDownload: post: description: '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. ' operationId: GenerateMaskingPolicyForDownload parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking policy file will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Generates a downloadable file corresponding to the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateMaskingPolicyForDownloadDetails' description: Details to generate a masking policy file. required: true /maskingPolicies/{maskingPolicyId}/actions/generateReportForDownload: post: description: '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. ' operationId: GenerateMaskingReportForDownload parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking report will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Generates a downloadable masking report. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateMaskingReportForDownloadDetails' description: Details to generate a downloadable masking report. required: true /maskingPolicies/{maskingPolicyId}/actions/mask: post: description: Masks data using the specified masking policy. operationId: MaskData parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Data masking will be performed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Masks data using the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/MaskDataDetails' description: Details to mask data. required: true /maskingPolicies/{maskingPolicyId}/actions/upload: post: description: '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. ' operationId: UploadMaskingPolicy parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking policy will be uploaded. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Uploads a masking policy file to update the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: format: binary type: string description: Details to upload a masking policy file. required: true /maskingPolicies/{maskingPolicyId}/maskingColumns: get: description: 'Gets a list of masking columns present in the specified masking policy and based on the specified query parameters. ' operationId: ListMaskingColumns parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskingColumnSortByQueryParam' - $ref: '#/components/parameters/MaskingColumnLifecycleStateQueryParam' - $ref: '#/components/parameters/dataTypeQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/MaskingColumnGroupQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/IsMaskingEnabledQueryParam' - $ref: '#/components/parameters/IsSeedRequiredQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking columns retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingColumnCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking columns present in the specified masking policy and based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/MaskingColumn' patch: description: '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. ' operationId: PatchMaskingColumns parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The masking columns will be patched in the specified masking policy. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more columns in the specified masking policy. tags: - dataSafe x-example: "PATCH /20181201/maskingPolicies/ocid1.datasafemaskingpolicy.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/maskingColumns\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\":\n [{ \"operation\": \"INSERT\",\n \"selection\": \"items\",\n \"value\":{\n \"schemaName\": \"TEST\",\n \"objectName\": \"TEST\",\n \"objectType\": \"TABLE\",\n \"columnName\": \"FNAME\",\n \"sensitiveTypeId\": \"ocid1.datasafesensitivetype.oc1.phx.abuxgljr6l2nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a\",\n \"isMaskingEnabled\": true,\n \"description\":\"masking format first name\",\n \"maskingFormats\": [\n {\n \"condition\": \"1=1\",\n \"formatEntries\": [\n {\n \"type\": \"RANDOM_STRING\",\n \"startLength\":1,\n \"endLength\":6\n }]\n }]\n }\n },\n { \"operation\": \"INSERT\",\n \"selection\": \"items\",\n \"value\":{\n \"schemaName\": \"TEST\",\n \"objectName\": \"TEST\",\n \"objectType\": \"TABLE\",\n \"columnName\": \"LNAME\",\n \"sensitiveTypeId\": \"ocid1.datasafesensitivetype.oc1.phx.abuxgljr6l2nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd9a\",\n \"isMaskingEnabled\": true,\n \"description\":\"masking format first name\",\n \"maskingFormats\": [\n {\n \"condition\": \"1=1\",\n \"formatEntries\": [\n {\n \"type\": \"RANDOM_STRING\",\n \"startLength\":1,\n \"endLength\":6\n }]\n }]\n }\n }\n}\nPATCH /20181201/maskingPolicies/ocid1.datasafemaskingpolicy.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/maskingColumns\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='620']\",\n \"value\": {\"isMaskingEnabled\":false}\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='621']\",\n \"value\": {\n \"maskingFormats\":[{\n \"condition\": \"1=1\",\n \"formatEntries\": [{\n \"type\": \"RANDOM_STRING\",\n \"startLength\":1,\n \"endLength\":6\n }]\n }]\n }\n }]\n}\n" x-related-resource: '#/definitions/MaskingColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchMaskingColumnsDetails' description: Details to patch masking columns. required: true post: description: '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. ' operationId: CreateMaskingColumn parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking column is being created in the specified masking policy. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new masking column in the specified masking policy. tags: - dataSafe x-related-resource: '#/definitions/MaskingColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMaskingColumnDetails' description: Details to create a new masking column. required: true /maskingPolicies/{maskingPolicyId}/maskingColumns/actions/applyDifferenceToMaskingColumns: post: description: '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. ' operationId: ApplySdmMaskingPolicyDifference parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The difference will be applied. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Applies the difference of a SDM Masking policy difference resource to the specified masking policy. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MaskingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplySdmMaskingPolicyDifferenceDetails' description: Details to apply the SDM Masking policy difference columns to a masking policy. required: true /maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}: delete: description: Deletes the specified masking column. operationId: DeleteMaskingColumn parameters: - $ref: '#/components/parameters/MaskingColumnKeyPathParam' - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Masking column deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified masking column. tags: - dataSafe x-related-resource: '#/definitions/MaskingColumn' get: description: Gets the details of the specified masking column. operationId: GetMaskingColumn parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/MaskingColumnKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking column retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingColumn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified masking column. tags: - dataSafe put: description: '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. ' operationId: UpdateMaskingColumn parameters: - $ref: '#/components/parameters/MaskingColumnKeyPathParam' - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking column will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified masking column. tags: - dataSafe x-related-resource: '#/definitions/MaskingColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaskingColumnDetails' description: Details to update a masking column. required: true /maskingPolicies/{maskingPolicyId}/maskingObjects: get: description: 'Gets a list of masking objects present in the specified masking policy and based on the specified query parameters. ' operationId: ListMaskingObjects parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskingObjectSortByQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking objects retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking objects present in the specified masking policy and based on the specified query parameters. tags: - dataSafe /maskingPolicies/{maskingPolicyId}/maskingSchemas: get: description: 'Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters. ' operationId: ListMaskingSchemas parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskingSchemaSortByQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking schemas retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingSchemaCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters. tags: - dataSafe /maskingPolicies/{maskingPolicyId}/referentialRelations: get: description: 'Gets a list of referential relations present in the specified masking policy based on the specified query parameters. ' operationId: ListMaskingPolicyReferentialRelations parameters: - $ref: '#/components/parameters/MaskingPolicyIdPathParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/MaskPolicyRelationTypeQueryParam' - $ref: '#/components/parameters/MaskPolicyReferentialRelationsPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskPolicyReferentialRelationsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Referential relations retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicyReferentialRelationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of referential relations present in the specified masking policy based on the specified query parameters. tags: - dataSafe x-example: "GET /maskingPolicies//referentialRelations {\n \"items\": \n [{ \n \"maskingPolicyId\": \"ocid1.datasafemaskingpolicy.oc1.iad.exampleuniqueID\",\n \"relationType\": \"DB_DEFINED\",\n \"parent\":\n {\n \"schemaName\":\"TEST\",\n \"objectType\":\"TABLE\",\n \"objectName\":\"PURCHASE\",\n \"referentialColumnGroup\":[\"customer_id\", \"product_code\"]\n },\n \"child\": {\n \"schemaName\":\"TEST\",\n \"objectType\":\"TABLE\",\n \"objectName\":\"ORDER\",\n \"referentialColumnGroup\":[\"customer_id\", \"product_code\"]\n },\n \"maskingFormat\": [\"Random String\", \"Random String\"]\n \n]}\n" x-related-resource: '#/definitions/MaskingPolicyReferentialRelationSummary' /maskingPolicyHealthReports: get: description: Gets a list of masking policy health reports based on the specified query parameters. operationId: ListMaskingPolicyHealthReports parameters: - $ref: '#/components/parameters/MaskingPolicyHealthReportIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/MaskingPolicyHealthReportSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/MaskingPolicyIdQueryParam' - $ref: '#/components/parameters/MaskingLifecycleStateQueryParam' responses: 200: description: Masking policy health reports retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicyHealthReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking policy health reports based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicyHealthReport' /maskingPolicyHealthReports/{maskingPolicyHealthReportId}: delete: description: Deletes the specified masking policy health report. operationId: DeleteMaskingPolicyHealthReport parameters: - $ref: '#/components/parameters/MaskingPolicyHealthReportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking policy health report will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified masking policy health report. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicyHealthReport' get: description: Gets the details of the specified masking policy health report. operationId: GetMaskingPolicyHealthReport parameters: - $ref: '#/components/parameters/MaskingPolicyHealthReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking policy health report retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicyHealthReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified masking policy health report. tags: - dataSafe /maskingPolicyHealthReports/{maskingPolicyHealthReportId}/actions/changeCompartment: post: description: Moves the specified masking policy health report and its dependent resources into a different compartment. operationId: ChangeMaskingPolicyHealthReportCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MaskingPolicyHealthReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Masking policy health report moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified masking policy health report and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicyHealthReport' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMaskingPolicyHealthReportCompartmentDetails' description: Details to change the compartment of a masking policy. required: true /maskingPolicyHealthReports/{maskingPolicyHealthReportId}/logs: get: description: 'Gets a list of errors and warnings from a masking policy health check. ' operationId: ListMaskingPolicyHealthReportLogs parameters: - $ref: '#/components/parameters/MaskingPolicyHealthReportIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MaskingPolicyHealthReportLogsSortByQueryParam' - $ref: '#/components/parameters/MaskingPolicyHealthReportLogMessageTypeQueryParam' responses: 200: description: Masking health report logs retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingPolicyHealthReportLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of errors and warnings from a masking policy health check. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicyHealthReport' /maskingReports: get: description: Gets a list of masking reports based on the specified query parameters. operationId: ListMaskingReports parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MaskingPolicyIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskingReportSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: Masking reports retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking reports based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/MaskingPolicy' /maskingReports/{maskingReportId}: delete: description: Deletes the specified masking report. operationId: DeleteMaskingReport parameters: - $ref: '#/components/parameters/MaskingReportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The masking report will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified masking report. tags: - dataSafe x-related-resource: '#/definitions/MaskingReport' get: description: Gets the details of the specified masking report. operationId: GetMaskingReport parameters: - $ref: '#/components/parameters/MaskingReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking report retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified masking report. tags: - dataSafe /maskingReports/{maskingReportId}/maskedColumns: get: description: 'Gets a list of masked columns present in the specified masking report and based on the specified query parameters. ' operationId: ListMaskedColumns parameters: - $ref: '#/components/parameters/MaskingReportIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MaskedColumnSortByQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/MaskingColumnGroupQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masked columns retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskedColumnCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masked columns present in the specified masking report and based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/MaskedColumnSummary' /maskingReports/{maskingReportId}/maskingErrors: get: description: 'Gets a list of masking errors in a masking run based on the specified query parameters. ' operationId: ListMaskingErrors parameters: - $ref: '#/components/parameters/MaskingReportIdPathParam' - $ref: '#/components/parameters/MaskingErrorStepNameQueryParam' - $ref: '#/components/parameters/MaskingErrorSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Masking errors retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaskingErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of masking errors in a masking run based on the specified query parameters. tags: - dataSafe x-example: "GET maskingReports/ocid1.datasafemaskingreport.oc1.iad.abuwcljrmrs5ycf7nrtxe5x57xfrdvol7ssmpeskbmwuxy4ebavezog3ol2q/maskingErrors {\n\"items\":\n[\n {\n \"stepName\": \"POST_MASKING\",\n \"failedStatement\": \"TRUNCATE TABLE HCM.DEPARTMENTS\",\n \"error\": \"ORA-00942: table or view does not exist\"\n \"timeCreated\": \"2024-12-12T10:15:25.368Z\"\n }\n]\n" x-related-resource: '#/definitions/MaskingErrorSummary' /onPremConnectors: get: description: 'Gets a list of on-premises connectors. ' operationId: ListOnPremConnectors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OnPremConnectorIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OnPremConnectorLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: On-Premises connectors retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/OnPremConnectorSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of on-premises connectors. tags: - dataSafe post: description: 'Creates a new on-premises connector. ' operationId: CreateOnPremConnector parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The on-premises connector is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the on-premises connector. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremConnector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new on-premises connector. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOnPremConnectorDetails' description: The details used to create a new on-premises connector. required: true /onPremConnectors/{onPremConnectorId}: delete: description: Deletes the specified on-premises connector. operationId: DeleteOnPremConnector parameters: - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The on-premises connector will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 204: description: Request received successfully. The on-premises connector will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified on-premises connector. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' get: description: Gets the details of the specified on-premises connector. operationId: GetOnPremConnector parameters: - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: On-Premises connector retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremConnector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified on-premises connector. tags: - dataSafe put: description: Updates one or more attributes of the specified on-premises connector. operationId: UpdateOnPremConnector parameters: - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The on-premises connector will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified on-premises connector. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOnPremConnectorDetails' description: The details used to update a on-premises connector. required: true /onPremConnectors/{onPremConnectorId}/actions/changeCompartment: post: description: Moves the specified on-premises connector into a different compartment. operationId: ChangeOnPremConnectorCompartment parameters: - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: On-Premises connector moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the specified on-premises connector into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOnPremConnectorCompartmentDetails' description: The details used to change the compartment of an on-premises connector. required: true /onPremConnectors/{onPremConnectorId}/actions/generateConfiguration: post: description: 'Creates and downloads the configuration of the specified on-premises connector. ' operationId: GenerateOnPremConnectorConfiguration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: On-premises connector's configuration created and downloaded successfully. headers: content-length: description: Size of the file. schema: type: integer format: int64 last-modified: description: The date and time the on-premises connector configuration was last modified, in the format defined by HTTP-date. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates and downloads the configuration of the specified on-premises connector. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateOnPremConnectorConfigurationDetails' description: The details used to create and download on-premises connector's configuration. required: true /onPremConnectors/{onPremConnectorId}/wallet: put: description: 'Updates the wallet for the specified on-premises connector to a new version. ' operationId: UpdateOnPremConnectorWallet parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OnPremConnectorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The on-premises connector's wallet will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the wallet of the specified on-premises connector to a new version. tags: - dataSafe x-related-resource: '#/definitions/OnPremConnector' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOnPremConnectorWalletDetails' description: The details used to update an on-premises connector's wallet. required: true /registrationPolicies: get: description: 'Retrieves a list of registration policies according to the specified query parameters. ' operationId: ListRegistrationPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RegistrationPoliciesSortByQueryParam' - $ref: '#/components/parameters/RegistrationPoliciesLifecycleStateQueryParam' - $ref: '#/components/parameters/RegistrationPoliciesEnablementLevelQueryParam' - $ref: '#/components/parameters/RegistrationPoliciesResourceIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RegistrationPolicyIdQueryParam' - $ref: '#/components/parameters/RegistrationPolicyConnectionTypeQueryParam' - $ref: '#/components/parameters/RegistrationPolicyConnectionIdQueryParam' responses: 200: description: List of registration policies. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RegistrationPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the list of Registration Policies according to the specified query parameters. tags: - dataSafe x-example: 'GET /20181201/registrationPolicies Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/RegistrationPolicySummary' post: description: Creates a new OptIn/Registration Policy operationId: CreateRegistrationPolicy parameters: - $ref: '#/components/parameters/DryRunHeader' - $ref: '#/components/parameters/ClusterIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The registration policy is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RegistrationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new OptIn/Registration Policy tags: - dataSafe x-example: 'POST /20181201/registrationPolicies ' x-related-resource: '#/definitions/RegistrationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRegistrationPolicyDetails' description: Details of the Registration Policy required: true /registrationPolicies/{registrationPolicyId}: delete: description: Deletes the specified registration policy. operationId: DeleteRegistrationPolicy parameters: - $ref: '#/components/parameters/RegistrationPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Registration Policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified registration policy. tags: - dataSafe x-related-resource: '#/definitions/RegistrationPolicy' get: description: 'Returns the details of the specified Registration Policy. ' operationId: GetRegistrationPolicy parameters: - $ref: '#/components/parameters/RegistrationPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the registration policy. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RegistrationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the details of the specified Registration Policy. tags: - dataSafe x-example: 'GET /20181201/registrationPolicies/{registrationPolicyId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/RegistrationPolicy' put: description: Updates one or more attributes of the specified registration policy. operationId: UpdateRegistrationPolicy parameters: - $ref: '#/components/parameters/RegistrationPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The Registration Policy will be updated. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RegistrationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified registration policy. tags: - dataSafe x-example: 'PUT /20181201/registrationPolicies/{registrationPolicyId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/RegistrationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRegistrationPolicyDetails' description: Details used to update the registration policy. required: true /registrationPolicies/{registrationPolicyId}/actions/changeCompartment: post: description: Moves the registration policy to the specified compartment. operationId: ChangeRegistrationPolicyCompartment parameters: - $ref: '#/components/parameters/RegistrationPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The Registration Policy will be moved. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RegistrationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the registration policy to the specified compartment. tags: - dataSafe x-example: "POST /20160918/registrationPolicies/<registrationPolicyId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/RegistrationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRegistrationPolicyCompartmentDetails' description: Details of the move compartment request. required: true /reportDefinitions: get: description: '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. ' operationId: ListReportDefinitions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ReportDefinitionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsSeededQueryParam' - $ref: '#/components/parameters/DataSourceQueryParam' - $ref: '#/components/parameters/ReportDefinitionLifecycleStateQueryParam' - $ref: '#/components/parameters/ReportDefinitionCategoryQueryParam' responses: 200: description: A list of report definition objects retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReportDefinitionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of report definitions. The report definitions can be seeded or user created. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' post: description: 'Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment. ' operationId: CreateReportDefinition parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The report definition is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReportDefinition' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new report definition tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReportDefinitionDetails' description: Details for the new report definition. required: true /reportDefinitions/{reportDefinitionId}: delete: description: Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted. operationId: DeleteReportDefinition parameters: - $ref: '#/components/parameters/reportDefinitionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Report definition will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified report definition tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' get: description: Gets the details of report definition specified by the identifier operationId: GetReportDefinition parameters: - $ref: '#/components/parameters/reportDefinitionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Report definition retrieved successfully headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReportDefinition' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets details of the specified report definition tags: - dataSafe put: description: 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. operationId: UpdateReportDefinition parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportDefinitionIdPathParam' responses: 202: description: Request received successfully. The specified report definition will be modified. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Updates the specified report definition. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateReportDefinitionDetails' description: Details for the modified report definition. required: true /reportDefinitions/{reportDefinitionId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeReportDefinitionCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportDefinitionIdPathParam' responses: 202: description: Request received successfully. The report definition will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeReportDefinitionCompartmentDetails' description: Details for the different ReportDefinition. required: true /reportDefinitions/{reportDefinitionId}/actions/generateReport: post: description: Generates a .xls or .pdf report based on parameters and report definition. operationId: GenerateReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportDefinitionIdPathParam' - $ref: '#/components/parameters/ReportScimQueryParam' responses: 202: description: Request received successfully. The report will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Generates a .xls or .pdf report. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateReportDetails' description: Details for report generation. It contains details such as PDF/XLS and filter parameters like audit event time limits, number of rows and target databases etc required: true /reportDefinitions/{reportDefinitionId}/actions/removeScheduleReport: post: description: Deletes the schedule of a .xls or .pdf report. operationId: RemoveScheduleReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportDefinitionIdPathParam' responses: 202: description: Request received successfully. The report schedule will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Deletes schedule of a .xls or .pdf report. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' /reportDefinitions/{reportDefinitionId}/actions/scheduleReport: post: description: Schedules a .xls or .pdf report based on parameters and report definition. operationId: ScheduleReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportDefinitionIdPathParam' responses: 202: description: Request received successfully. The report will be scheduled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Schedules a .xls or .pdf report. tags: - dataSafe x-related-resource: '#/definitions/ReportDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleReportDetails' description: The details for the audit report schedule. It contains details such as schedule, MIME type .xls/.pdf and number of rows. required: true /reports: get: description: Gets a list of all the reports in the compartment. It contains information such as report generation time. operationId: ListReports parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam1' - $ref: '#/components/parameters/ReportMimeTypeQueryParam' - $ref: '#/components/parameters/reportDefinitionIdQueryParam' - $ref: '#/components/parameters/TimeGeneratedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeGeneratedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ReportLifecycleStateQueryParam' - $ref: '#/components/parameters/ReportTypeQueryParam' - $ref: '#/components/parameters/DataSourceQueryParam' responses: 200: description: A summary page of report objects retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the reports in the compartment. tags: - dataSafe x-related-resource: '#/definitions/ReportSummary' /reports/{reportId}: get: description: Gets a report by identifier operationId: GetReport parameters: - $ref: '#/components/parameters/reportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the specified report details successfully headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Report' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified report. tags: - dataSafe put: description: Updates the specified report. Only tags can be updated. operationId: UpdateReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportIdPathParam' responses: 202: description: Accepted the request. The specified report will be modified. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Updates the specified report. tags: - dataSafe x-related-resource: '#/definitions/Report' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateReportDetails' description: Details for the modified report. required: true /reports/{reportId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeReportCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/reportIdPathParam' responses: 202: description: Request received successfully. The report will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/Report' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeReportCompartmentDetails' description: Details for the different Report. required: true /reports/{reportId}/content: get: description: Downloads the specified report in the form of .xls or .pdf. operationId: GetReportContent parameters: - $ref: '#/components/parameters/reportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Downloads the specified report in the form of PDF or XLXS. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string last-modified: description: The date and time the report was last modified, in the format defined by HTTP-date. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Download the specified report. tags: - dataSafe x-related-resource: '#/definitions/Report' /sdmMaskingPolicyDifferences: get: description: Gets a list of SDM and masking policy difference resources based on the specified query parameters. operationId: ListSdmMaskingPolicyDifferences parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/DifferenceAccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceLifecycleStateQueryParam' - $ref: '#/components/parameters/MaskingPolicyIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: SDM masking policy difference resources retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SdmMaskingPolicyDifferenceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of SDM and masking policy difference resources based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/SdmMaskingPolicyDifference' post: description: '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. ' operationId: CreateSdmMaskingPolicyDifference parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. SDM Masking policy difference resource is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the SDM Masking policy difference. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SdmMaskingPolicyDifference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 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. tags: - dataSafe requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSdmMaskingPolicyDifferenceDetails' description: The details used to create a SDM masking policy difference resource required: true /sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}: delete: description: Deletes the specified SDM Masking policy difference. operationId: DeleteSdmMaskingPolicyDifference parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The SDM Masking policy difference will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified SDM Masking policy difference. tags: - dataSafe x-related-resource: '#/definitions/SdmMaskingPolicyDifference' get: description: Gets the details of the specified SDM Masking policy difference. operationId: GetSdmMaskingPolicyDifference parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SDM masking policy difference retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SdmMaskingPolicyDifference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified SDM Masking policy difference. tags: - dataSafe put: description: Updates one or more attributes of the specified sdm masking policy difference. operationId: UpdateSdmMaskingPolicyDifference parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sdm masking policy difference will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sdm masking policy difference. tags: - dataSafe x-related-resource: '#/definitions/SdmMaskingPolicyDifference' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSdmMaskingPolicyDifferenceDetails' description: Details to update a sdm masking policy difference. required: true /sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/actions/changeCompartment: post: description: Moves the specified SDM masking policy difference into a different compartment. operationId: ChangeSdmMaskingPolicyDifferenceCompartment parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Moves the SDM Masking policy difference to the given compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified SDM masking policy difference into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/SdmMaskingPolicyDifference' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSdmMaskingPolicyDifferenceCompartmentDetails' description: The details used to change the compartment of a resource. required: true /sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns: get: description: Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters. operationId: ListDifferenceColumns parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/DifferenceTypeQueryParam' - $ref: '#/components/parameters/PlannedActionForDifferenceColumnQueryParam' - $ref: '#/components/parameters/SyncStatusQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceColumnSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: SDM Masking policy difference columns retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SdmMaskingPolicyDifferenceColumnCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/SdmMaskingPolicyDifference' patch: description: '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. ' operationId: PatchSdmMaskingPolicyDifferenceColumns parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The SDM masking policy difference columns will be patched. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more SDM masking policy difference columns. tags: - dataSafe x-example: "PATCH /sdmMaskingPolicyDifferences/ocid1.sdmMaskingPolicyDifference.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/columns {\n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[*]\",\n \"value\": {\n \"plannedAction\":\"NO_SYNC\"\n }\n }]\n}\nPATCH /sdmMaskingPolicyDifferences/ocid1.sdmMaskingPolicyDifference.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/columns {\n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[?differenceType=='NEW']\",\n \"value\": {\n \"plannedAction\":\"NO_SYNC\"}\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='21']\",\n \"value\": {\n \"plannedAction\":\"NO_SYNC\"\n }\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?differenceType=='MODIFIED']\",\n \"value\":{\n \"plannedAction\":\"NO_SYNC\"\n }\n }\n ]\n}\n" x-related-resource: '#/definitions/SdmMaskingPolicyDifference' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchSdmMaskingPolicyDifferenceColumnsDetails' description: Details to patch difference columns. required: true /sdmMaskingPolicyDifferences/{sdmMaskingPolicyDifferenceId}/differenceColumns/{differenceColumnKey}: get: description: Gets the details of the specified SDM Masking policy difference column. operationId: GetDifferenceColumn parameters: - $ref: '#/components/parameters/SdmMaskingPolicyDifferenceIdPathParam' - $ref: '#/components/parameters/DifferenceColumnKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SDM Masking policy difference column retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DifferenceColumn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified SDM Masking policy difference column. tags: - dataSafe /securityAssessments: get: description: '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. ' operationId: ListSecurityAssessments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityAssessmentTypeQueryParam' - $ref: '#/components/parameters/ScheduleSecurityAssessmentIdQueryParam' - $ref: '#/components/parameters/IsScheduleSecurityAssessmentQueryParam' - $ref: '#/components/parameters/SecurityAssessmentTriggeredByQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/IsSecurityAssessmentBaselineQueryParam' - $ref: '#/components/parameters/SecurityAssessmentSortByQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityAssessmentLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityAssessmentTargetTypeQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/TemplateAssessmentIdQueryParam' responses: 200: description: The security assessments were retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityAssessmentSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets a list of security assessments. Security assessments can be of type: LATEST, SAVED, SAVE_SCHEDULE, TEMPLATE, TEMPLATE_BASELINE or COMPARTMENT. When using COMPARTMENT type, the list of all security assessments across all compartments will be returned. ' tags: - dataSafe x-example: 'GET /20181201/securityAssessments Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new saved security assessment for a target database or target database group in a compartment. When this operation is performed, it will save the latest assessment in the specified compartment. If a schedule is passed, it will persist the latest assessment, at the defined date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' operationId: CreateSecurityAssessment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Request received successfully. The security assessment will be created and saved. ' headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'Full URI of the created security assessment. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAssessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new saved security assessment. tags: - dataSafe x-example: "POST /20181201/securityAssessments\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EBS assessment\",\n \"targetId\": \"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesiswk\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"freeformTags\": {\n \"env\": \"dev\",\n \"val\": \"testing\"\n },\n \"definedTags\": {\n \"defined\": {\n \"use\": \"datasafe\"\n }\n }\n}\n" x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityAssessmentDetails' description: The details used to create a new saved security assessment. required: true /securityAssessments/findingAnalytics: get: description: '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. ' operationId: ListFindingAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/IsTopFindingQueryParam' - $ref: '#/components/parameters/FindingAnalyticsGroupBy' - $ref: '#/components/parameters/TopFindingStatusQueryParam' - $ref: '#/components/parameters/SeverityQueryParam' - $ref: '#/components/parameters/FindingKeyQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsReferencesQueryParam' - $ref: '#/components/parameters/TargetIdsQueryParam' - $ref: '#/components/parameters/CategoryQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsSeverityQueryParam' - $ref: '#/components/parameters/FindingAnalyticsScimQueryParam' responses: 200: description: Finding analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FindingAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of findings aggregated details in the specified compartment. tags: - dataSafe x-example: "GET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}\n{\n \"items\": [\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"PASS\", \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"HIGH\", \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"LOW\", \"targetId\": \"t6\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"EVALUATE\", \"targetId\": \"t7\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"ADVISORY\", \"targetId\": \"t8\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"DEFERRED\", \"targetId\": \"t9\"}, \"count\": 1},\n\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"PASS\", \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"HIGH\", \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"MEDIUM\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"MEDIUM\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"MEDIUM\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"LOW\", \"targetId\": \"t6\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"EVALUATE\", \"targetId\": \"t7\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"ADVISORY\", \"targetId\": \"t8\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"DEFERRED\", \"targetId\": \"t9\"}, \"count\": 1}\n ]\n}\n\nGET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}&groupBy=findingKeyAndSeverity\n{\n \"items\": [\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"PASS\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"HIGH\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\"}, \"count\": 3},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"LOW\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"EVALUATE\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"ADVISORY\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"DEFERRED\"}, \"count\": 1},\n\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"PASS\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"HIGH\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"MEDIUM\"}, \"count\": 3},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"LOW\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"EVALUATE\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"ADVISORY\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"title\": \"Audit User Logon / Logoff\", \"category\": \"AUDITING\", \"severity\": \"DEFERRED\"}, \"count\": 1}\n ]\n}\n\nGET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}&findingKey=USER.SAMPLE&severity=MEDIUM\n{\n \"items\": [\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"FINDING_STATS\", \"dimensions\": { \"key\":\"USER.SAMPLE\", \"title\": \"Sample Schemas\", \"category\": \"USER ACCOUNTS\", \"severity\": \"MEDIUM\", \"targetId\": \"t5\"}, \"count\": 1}\n ]\n}\n\nGET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}&isTopFinding=true\n{\n \"items\": [\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"PASS\", \"category\": \"AUDITING\", \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\", \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\", \"targetId\": \"t6\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"EVALUATE\", \"category\": \"AUDITING\", \"targetId\": \"t7\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"ADVISORY\", \"category\": \"AUDITING\", \"targetId\": \"t8\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"DEFERRED\", \"category\": \"AUDITING\", \"targetId\": \"t9\"}, \"count\": 1},\n\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"RISK\", \"category\": \"Data Encryption\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"RISK\", \"category\": \"Data Encryption\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"RISK\", \"category\": \"Data Encryption\", \"targetId\": \"t6\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"EVALUATE\", \"category\": \"Data Encryption\", \"targetId\": \"t7\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"ADVISORY\", \"category\": \"Data Encryption\", \"targetId\": \"t8\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"DEFERRED\", \"category\": \"Data Encryption\", \"targetId\": \"t9\"}, \"count\": 1}\n ]\n}\n\nGET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}&isTopFinding=true&groupBy=findingKeyAndTopFindingStatus\n{\n \"items\": [\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"PASS\", \"category\": \"AUDITING\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"RISK\", \"category\": \"AUDITING\"}, \"count\": 5},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"EVALUATE\", \"category\": \"AUDITING\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"ADVISORY\", \"category\": \"AUDITING\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"AUDIT.CONN\", \"topFindingCategory\": \"Auditing\", \"topFindingStatus\": \"DEFERRED\", \"category\": \"AUDITING\"}, \"count\": 1},\n\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\"}, \"count\": 3},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"RISK\", \"category\": \"Data Encryption\"}, \"count\": 3,\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"EVALUATE\", \"category\": \"Data Encryption\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"ADVISORY\", \"category\": \"Data Encryption\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"DEFERRED\", \"category\": \"Data Encryption\"}, \"count\": 1}\n ]\n}\n\nGET /20181201/securityAssessments/findingAnalytics?compartmentId={compartmentId}&isTopFinding=true&findingKey=CRYPT.TDE&topFindingStatus=PASS\n{\n \"items\": [\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t1\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t2\"}, \"count\": 1},\n { \"metricName\": \"TOP_FINDING_STATS\", \"dimensions\": { \"key\":\"CRYPT.TDE\", \"topFindingCategory\": \"Encryption at-rest\", \"topFindingStatus\": \"PASS\", \"category\": \"Data Encryption\", \"targetId\": \"t3\"}, \"count\": 1}\n ]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/securityFeatureAnalytics: get: description: '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. ' operationId: ListSecurityFeatureAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' responses: 200: description: Database security feature analytics retrieved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityFeatureAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of Database security feature usage aggregated details in the specific compartment. tags: - dataSafe x-example: "GET /20181201/securityAssessments/securityFeatureAnalytics?compartmentId={compartmentId}\n{\n\"items\": [\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"UNIFIED_AUDIT\"}, \"count\": 3},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"FINE_GRAINED_AUDIT\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"TRADITIONAL_AUDIT\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"DATABASE_VAULT\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"PRIVILEGE_ANALYSIS\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"TABLESPACE_ENCRYPTION\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"COLUMN_ENCRYPTION\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"NETWORK_ENCRYPTION\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"PASSWORD_AUTHENTICATION\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"GLOBAL_AUTHENTICATION\"}, \"count\": 1},\n { \"metricName\": \"SECURITY_FEATURE_STATS\", \"dimensions\": { \"securityFeature\":\"EXTERNAL_AUTHENTICATION\"}, \"count\": 1}\n]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/securityFeatures: get: description: 'Lists the usage of Database security features for a given compartment or a target level, based on the filters provided. ' operationId: ListSecurityFeatures parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetsWithUnifiedAuditQueryParam' - $ref: '#/components/parameters/TargetsWithFineGrainedAuditQueryParam' - $ref: '#/components/parameters/TargetsWithTraditionalAuditQueryParam' - $ref: '#/components/parameters/TargetsWithDatabaseVaultQueryParam' - $ref: '#/components/parameters/TargetsWithPrivilegeAnalysisQueryParam' - $ref: '#/components/parameters/TargetsWithTablespaceEncryptionQueryParam' - $ref: '#/components/parameters/TargetsWithColumnEncryptionQueryParam' - $ref: '#/components/parameters/TargetsWithNetworkEncryptionQueryParam' - $ref: '#/components/parameters/TargetsWithPasswordAuthenticationQueryParam' - $ref: '#/components/parameters/TargetsWithGlobalAuthenticationQueryParam' - $ref: '#/components/parameters/TargetsWithExternalAuthenticationQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' responses: 200: description: Database security feature usage retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityFeatureCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Lists the usage of Database security features for a given compartment or a target level, based on the filters provided. ' tags: - dataSafe x-example: "GET /20181201/securityAssessments/securityFeatures\n Host: datasafe.us-phoenix-1.oci.oraclecloud.com\n\n" x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/templateAnalytics: get: description: 'Gets a list of template aggregated details in the specified compartment. This provides information about the overall template usage, by returning the count of the target databases/target groups using the templates. It also provides information about the statistics for the template baseline and the comparison related. If the comparison is done, it will show if there is any drift, and how many checks have drifts. The dimension field - isGroup identifies if the targetId belongs to a target group or a individual target. The dimension field - isCompared identifies if the comparison between the latest assessment and the template baseline assessment is done or not. The dimension field - isCompliant identifies if the latest assessment is compliant with the template baseline assessment or not. The dimension field - totalChecksFailed identifies how many checks in the template have drifts in the comparison. When you perform the ListTemplateAnalytics 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. ' operationId: ListTemplateAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TemplateAssessmentIdQueryParam' - $ref: '#/components/parameters/TemplateBaselineAssessmentIdQueryParam' - $ref: '#/components/parameters/IsTargetGroupQueryParam' - $ref: '#/components/parameters/IsComparedQueryParam' - $ref: '#/components/parameters/IsCompliantQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Template analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplateAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of template aggregated details in the specific compartment. tags: - dataSafe x-example: "GET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"t1\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 4, \"totalTargets\":6, \"totalNonCompliantTargets\":3}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid12\", \"targetDatabaseGroupId\": \"t2\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 2, \"totalTargets\":5, \"totalNonCompliantTargets\":2}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid15\", \"targetId\": \"t5\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 3, \"totalTargets\":1, \"totalNonCompliantTargets\":1}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid2\", \"totalChecks\":7, \"templateBaselineAssessmentId\":\"ocid23\", \"targetId\": \"t3\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 1, \"totalTargets\":1, \"totalNonCompliantTargets\":1}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"totalChecks\":6, \"templateBaselineAssessmentId\":\"ocid34\", \"targetId\": \"t4\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": true, \"totalChecksFailed\": 0, \"totalTargets\":1, \"totalNonCompliantTargets\":0}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"totalChecks\":5, \"templateBaselineAssessmentId\":\"ocid36\", \"targetDatabaseGroupId\": \"t6\", \"isGroup\": true, \"isCompared\": false}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}&templateAssessmentId={ocid1}\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"t1\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 4, \"totalTargets\":6, \"totalNonCompliantTargets\":3}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid12\", \"targetDatabaseGroupId\": \"t2\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 2, \"totalTargets\":5, \"totalNonCompliantTargets\":2}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid15\", \"targetId\": \"t5\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 3, \"totalTargets\":1, \"totalNonCompliantTargets\":1}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}&isGroup=true\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"t1\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 4, \"totalTargets\":6, \"totalNonCompliantTargets\":3}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid12\", \"targetDatabaseGroupId\": \"t2\", \"isGroup\": true, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 2, \"totalTargets\":5, \"totalNonCompliantTargets\":2}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}&templateAssessmentId={ocid1}&isGroup=false \n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"totalChecks\":9, \"templateBaselineAssessmentId\":\"ocid15\", \"targetId\": \"t5\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": false, \"totalChecksFailed\": 3, \"totalTargets\":1, \"totalNonCompliantTargets\":1}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}&isGroup=true&isCompared=false\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"totalChecks\":5, \"templateBaselineAssessmentId\":\"ocid36\", \"targetDatabaseGroupId\": \"t6\", \"isGroup\": true, \"isCompared\": false}, \"count\": 1}\n]\n}\nGET /20181201/securityAssessments/templateAnalytics?compartmentId={compartmentId}&isGroup=false&isCompared=true&isCompliant=true\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"totalChecks\":6, \"templateBaselineAssessmentId\":\"ocid34\", \"targetId\": \"t4\", \"isGroup\": false, \"isCompared\": true, \"timeLastCompared\":\"2024-09-19T19:11:09.561Z\", \"isCompliant\": true, \"totalChecksFailed\": 0, \"totalTargets\":1, \"totalNonCompliantTargets\":0}, \"count\": 1},\n]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/templateAssociationAnalytics: get: description: "Gets a list of template association details in the specified compartment. This provides information about the\noverall template usage, by returning the count of the target databases/target groups using the templates.\n\nIf the template baseline is created for a target group which contains several targets, we will have each individual target \nlisted there as targetId field together with targetDatabaseGroupId. And if the template baseline is created for an individual target,\nit will have targetId field only.\n\nBy leveraging the targetId filter, you will be able to know all the template or template baseline that this target has something to do with.\nNo matter if they are directly applied or created for this target, or they are for the target group the target belongs to.\n\nWhen you perform the ListTemplateAssociationAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the\nparameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT\npermissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the\nroot compartment and the requestor does not have access to at least one subcompartment of the compartment specified by\ncompartmentId, then \"Not Authorized\" is returned.\n" operationId: ListTemplateAssociationAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TemplateAssessmentIdQueryParam' - $ref: '#/components/parameters/TemplateBaselineAssessmentIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Template association analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplateAssociationAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of template association details in the specific compartment. tags: - dataSafe x-example: "GET /20181201/securityAssessments/templateAssociationAnalytics?compartmentId={compartmentId}\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"tg1\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"tg1\", \"targetId\": \"t6\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid12\", \"targetDatabaseGroupId\": \"tg2\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid15\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid2\", \"templateBaselineAssessmentId\":\"ocid23\", \"targetId\": \"t3\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"templateBaselineAssessmentId\":\"ocid34\", \"targetId\": \"t4\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid3\", \"templateBaselineAssessmentId\":\"ocid36\", \"targetDatabaseGroupId\": \"tg3\", \"targetId\": \"t7\"}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAssociationAnalytics?compartmentId={compartmentId}&targetId={t5}\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"tg1\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid12\", \"targetDatabaseGroupId\": \"tg2\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid15\", \"targetId\": \"t5\"}, \"count\": 1}\n]\n}\n\nGET /20181201/securityAssessments/templateAssociationAnalytics?compartmentId={compartmentId}&targetDatabaseGroupId={tg1}\n{\n\"items\": [\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"tg1\", \"targetId\": \"t5\"}, \"count\": 1},\n { \"metricName\": \"TEMPLATE_ASSOCIATION_STATS\", \"dimensions\": { \"templateAssessmentId\":\"ocid1\", \"templateBaselineAssessmentId\":\"ocid11\", \"targetDatabaseGroupId\": \"tg1\", \"targetId\": \"t6\"}, \"count\": 1}\n]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/{securityAssessmentId}: delete: description: '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. ' operationId: DeleteSecurityAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 202: description: Request received successfully. The saved security assessment or schedule will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 204: description: Security assessment deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified security assessment. tags: - dataSafe x-example: 'DELETE /20181201/securityAssessments/<securityAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' get: description: Gets the details of the specified security assessment. operationId: GetSecurityAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 200: description: The security assessment was retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-example: application-json: "{\n \"id\" : \"ocid1.datasafeinstance.dev.securityassessment.absgk5rrvgzusipza2yjmvtdotpyz2h3wrnczeihusdzgeyewqhjcjg4gseq\",\n \"timeCreated\" : \"2020-04-02T10:01:05.433Z\",\n \"targetIds\" : [\"ocid1.target.dev.dev.assessment.absgk5rr3vdet6ucuj4x55xysfj77osp4mslehkcohpzczxi2ky5u5hjyfua\"],\n \"lifecycleState\" : \"CREATING\",\n \"type\": \"SAVED\"\n}\n" content: application/json: schema: $ref: '#/components/schemas/SecurityAssessment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified security assessment. tags: - dataSafe x-example: 'GET /20181201/securityAssessments/<securityAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: 'Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule. ' operationId: UpdateSecurityAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 202: description: Request received successfully. The security assessment will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application-json: example: "{\n \"id\": \"ocid1.datasafeinstance.oc1.iad.securityassessment.abuwcljrb2tiozolgmjjylnfcpfl226whn5x3sqg5rcy4eryq7tndwcbl4ia\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"timeCreated\": \"2020-06-19T19:11:09.561Z\",\n \"timeUpdated\": \"2020-06-19T19:11:09.561Z\",\n \"lifecycleState\": \"UPDATING\",\n \"targetIds\" : [\"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesiswk\",\n \"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesisbg\"],\n \"displayName\" : \"EBS-2's assessment v1\",\n \"type\": \"SAVED\",\n \"freeformTags\": {\n \"env\": \"dev\",\n \"val\": \"testing\"\n },\n \"definedTags\": {\n \"defined\": {\n \"use\": \"datasafe\"\n }\n }\n}\n" 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified security assessment. tags: - dataSafe x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityAssessmentDetails' description: The information to be updated. required: true /securityAssessments/{securityAssessmentId}/actions/applyTemplate: post: description: Apply the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'. operationId: ApplySecurityAssessmentTemplate parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 202: description: The template was successfully applied to the security assessment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Apply the checks from the template to the specified security assessment. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/applyTemplate Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAssessmentTemplateDetails' description: Details of template that need to be applied to specified security assessment. required: true /securityAssessments/{securityAssessmentId}/actions/changeCompartment: post: description: '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. ' operationId: ChangeSecurityAssessmentCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 204: description: Security assessment moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the specified saved security assessment or future scheduled assessments into a different compartment. tags: - dataSafe x-example: "POST /20181201/securityAssessments/<securityAssessmentId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaakytcpccnbfnbyuorvbmgvldjzcvlssmaxogjhhyocngbbbcllwyh\"\n}\n" x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityAssessmentCompartmentDetails' description: The details used to change the compartment of a security assessment. required: true /securityAssessments/{securityAssessmentId}/actions/compare: post: description: '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. ' operationId: CompareSecurityAssessment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The security assessment comparison is being created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Compares security assessments. tags: - dataSafe x-example: "POST /20181201/<securityAssessmentId>/actions/compare\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<Authorization and other headers>\n{\n \"comparisonSecurityAssessmentId\": \"ocid1.assessment.oc1..aaaaaaaakytcpccnbfnbyuorvbmgvldjzcvlssmaxogjhhyocngbbbcllwyh\"\n}\n" x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompareSecurityAssessmentDetails' description: Details of the security assessment comparison. required: true /securityAssessments/{securityAssessmentId}/actions/compareToTemplateBaseline: post: description: 'Compares two security assessments. For this comparison, the security assessment in the path needs to be a latest assessment of a target group. ' operationId: CompareToTemplateBaseline parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The security assessment comparison is being created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Compares latest target-group security assessment to template-baseline security assessment. tags: - dataSafe x-example: "POST /20181201/<securityAssessmentId>/actions/compareToTemplateBaseline\nHost: datasafe.us-ashburn-1.oci.oraclecloud.com\n<Authorization and other headers>\n{\n \"comparisonSecurityAssessmentId\": \"ocid1.assessment.oc1..aaaaaaaakytcpccnbfnbyuorvbmgvldjzcvlssmaxogjhhyocngbbbcllwyh\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompareToTemplateBaselineDetails' description: Details of the security assessment comparison which pass the template baseline assessment ocid. required: true /securityAssessments/{securityAssessmentId}/actions/downloadReport: post: description: '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). ' operationId: DownloadSecurityAssessmentReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 200: description: Security assessment report retrieved successfully. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Downloads the report of the specified security assessment. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/downloadReport Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadSecurityAssessmentReportDetails' description: Details of the report. required: true /securityAssessments/{securityAssessmentId}/actions/generateReport: post: description: '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. ' operationId: GenerateSecurityAssessmentReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 202: description: The request is deferred. Security assessment report will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Generates the report of the specified security assessment. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/generateReport Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateSecurityAssessmentReportDetails' description: Details of the report. required: true /securityAssessments/{securityAssessmentId}/actions/refresh: post: description: '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. ' operationId: RefreshSecurityAssessment parameters: - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 201: description: Request received successfully. The security assessment will be performed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Runs a security assessment, updates the latest assessment, and saves it for future reference. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/refresh Host: datasafe.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/RunSecurityAssessmentDetails' description: Details to create an on-demand saved security assessment. required: true /securityAssessments/{securityAssessmentId}/actions/removeTemplate: post: description: Remove the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'. operationId: RemoveSecurityAssessmentTemplate parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 202: description: The template was successfully removed from the security assessment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Remove the checks from the template to the specified security assessment. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/removeTemplate Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/{securityAssessmentId}/actions/setBaseline: post: description: 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'. operationId: SetSecurityAssessmentBaseline parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 200: description: The saved security assessment was successfully set as a baseline. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/setBaseline Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/SecurityAssessmentBaseLineDetails' description: Details of security assessment that need to be updated while setting the baseline. /securityAssessments/{securityAssessmentId}/actions/unsetBaseline: post: description: 'Removes the baseline setting for the saved security assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. ' operationId: UnsetSecurityAssessmentBaseline parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' responses: 200: description: Request is received successfully. Baseline setting for the saved security assessment will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline. tags: - dataSafe x-example: 'POST /20181201/securityAssessments/<securityAssessmentId>/actions/unsetBaseline Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnsetSecurityAssessmentBaselineDetails' description: Details of the target associated with the security assessment for which the user intents to unset the baseline. /securityAssessments/{securityAssessmentId}/checks: get: description: 'Lists all the security checks in the specified compartment for security assessment of type TEMPLATE. ' operationId: ListChecks parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CheckSortByQueryParam' - $ref: '#/components/parameters/SuggestedSeverityQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsSeverityQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsReferencesQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - description: 'Each check in security assessment has an associated key (think of key as a check''s name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks. ' in: query name: key required: false x-default-description: 'Each check in security assessment has an associated key (think of key as a check''s name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks. ' schema: type: string responses: 200: description: 'An array containing the checks belonging to the specified security assessment. ' headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CheckSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Lists all the security checks in the specified compartment for security assessment of type TEMPLATE. ' tags: - dataSafe x-example: 'GET /20181201/securityAssessments/{securityAssessmentId}/checks Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' patch: description: 'Patches one or more checks in the specified template type security assessment. Use it to add or delete checks. To add check, use CreateCheckDetails as the patch value. ' operationId: PatchChecks parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The checks will be updated in the specified template type security assessment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more checks in the specified security assessment. tags: - dataSafe x-example: "PATCH /20181201/securityAssessments/ocid1.datasafesecurityassessment.oc1.iad.abuwcljrxjszwsh5swrabwmn/checks \n{\n \"items\": \n [{\n \"operation\" : \"INSERT\",\n \"selection\": \"items\",\n \"value\" : {\n \"key\": \"USER.APPOWNER\"\n }\n },\n {\n \"operation\" : \"REMOVE\",\n \"selection\": \"items[?key=='USER.INACTIVE']\"\n }]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchChecksDetails' description: Details to patch checks. required: true /securityAssessments/{securityAssessmentId}/comparison/{comparisonSecurityAssessmentId}: get: description: Gets the details of the comparison report for the security assessments submitted for comparison. operationId: GetSecurityAssessmentComparison parameters: - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/ComparisonSecurityAssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists the details of the comparison report. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-example: application-json: "{\n \"targets\": [\n {\n \"baselineTargetId\": \"ocid1.datasafeinstance.oc1.iad.assessment.abuwcljr4hj4fjrs64h4e4rnoysmujtm5pg6xxltum6zrto5kqludyy72hha\",\n \"currentTargetId\": \"ocid1.datasafeinstance.oc1.iad.assessment.abuwcljrmvckgg67bxjsyqxfnm6wlu6jgifklffznni5whbavqjvgu35wldq\",\n \"privilegesAndRoles\": [\n {\n \"current\": {\n \"severity\": \"ADVISORY\",\n \"title\": \"System Privilege Grants\",\n \"remarks\": \"System privileges provide the ability to access data or perform administrative operations for the entire database. Consistent with the principle of least privilege, these privileges should be granted sparingly. The Privilege Analysis feature may be helpful to determine the minimum set of privileges required by a user or role. In some cases, it may be possible to substitute a more limited object privilege grant in place of a system privilege grant that applies to all objects. System privileges should be granted with admin option only when the recipient needs the ability to grant the privilege to others.\",\n \"summary\": \"123 out of 126 users have been directly or indirectly granted system privileges via 25207 grants.\\n 1 user is granted system privileges with admin option via 6 grants.\\n 118 users are granted 191 system privileges directly.\\n\",\n \"references\": {\n \"stig\": \"Rule SV-75923r3, SV-76065r1, SV-76081r3, SV-76299r3\",\n \"cis\": \"Recommendation 4.7\"\n }\n },\n \"baseline\": {\n \"severity\": \"ADVISORY\",\n \"title\": \"System Privilege Grants\",\n \"remarks\": \"System privileges provide the ability to access data or perform administrative operations for the entire database. Consistent with the principle of least privilege, these privileges should be granted sparingly. The Privilege Analysis feature may be helpful to determine the minimum set of privileges required by a user or role. In some cases, it may be possible to substitute a more limited object privilege grant in place of a system privilege grant that applies to all objects. System privileges should be granted with admin option only when the recipient needs the ability to grant the privilege to others.\",\n \"summary\": \"122 out of 125 users have been directly or indirectly granted system privileges via 24971 grants.\\n 1 user is granted system privileges with admin option via 6 grants.\\n 117 users are granted 190 system privileges directly.\\n\",\n \"references\": {\n \"stig\": \"Rule SV-75923r3, SV-76065r1, SV-76081r3, SV-76299r3\",\n \"cis\": \"Recommendation 4.7\"\n }\n },\n \"removed\": [],\n \"added\": [\n \"CREATE JOB: [MALFOY]\\n\",\n \"DROP ANY CONTEXT: [MALFOY]\\n\",\n \"UPDATE ANY CUBE: [MALFOY]\\n\",\n \"DROP ANY TRIGGER: [MALFOY]\\n\",\n \"ALTER ANY ANALYTIC VIEW: [MALFOY]\\n\"\n ]\n }],\n \"userAccounts\": [\n {\n \"current\": {\n \"severity\": \"MEDIUM\",\n \"title\": \"User Schemas in SYSTEM or SYSAUX Tablespace\",\n \"remarks\": \"The SYSTEM and SYSAUX tablespaces are reserved for Oracle-supplied user accounts. To avoid a possible denial of service caused by exhausting these resources, regular user schemas should not use these tablespaces. \",\n \"summary\": \"Found 112 users using SYSTEM or SYSAUX tablespace.\",\n \"references\": {}\n },\n \"baseline\": {\n \"severity\": \"MEDIUM\",\n \"title\": \"User Schemas in SYSTEM or SYSAUX Tablespace\",\n \"remarks\": \"The SYSTEM and SYSAUX tablespaces are reserved for Oracle-supplied user accounts. To avoid a possible denial of service caused by exhausting these resources, regular user schemas should not use these tablespaces. \",\n \"summary\": \"Found 111 users using SYSTEM or SYSAUX tablespace.\",\n \"references\": {}\n },\n \"removed\": [],\n \"added\": [\n \"MALFOY\"\n ]\n }]\n }]\n}\n" content: application/json: schema: $ref: '#/components/schemas/SecurityAssessmentComparison' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the comparison report for the provided security assessments. tags: - dataSafe x-example: 'GET /20181201/securityAssessments/<securityAssessmentId>/comparison/<comparisonSecurityAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/{securityAssessmentId}/findings: get: description: 'Lists all the findings for the specified assessment except for type TEMPLATE. If the assessment is of type TEMPLATE_BASELINE, the findings returned are the security checks with the user-defined severity from the template. ' operationId: ListFindings parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/IsTopFindingQueryParam' - $ref: '#/components/parameters/SeverityQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsSeverityQueryParam' - $ref: '#/components/parameters/CategoryQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsOracleDefinedSeverityQueryParam' - $ref: '#/components/parameters/FindingLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityAssessmentReferencesQueryParam' - $ref: '#/components/parameters/SecurityAssessmentContainsReferencesQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetIdsQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'Each finding in security assessment has an associated key (think of key as a finding''s name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings. ' in: query name: findingKey required: false x-default-description: 'Each finding in security assessment has an associated key (think of key as a finding''s name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings. ' schema: type: string responses: 200: description: 'An array containing the findings from all the targets belonging to the specified security assessment. ' headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/FindingSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Lists all the findings for the specified assessment except for type TEMPLATE. If the assessment is of type TEMPLATE_BASELINE, the findings returned are the security checks with the user-defined severity from the template. ' tags: - dataSafe x-related-resource: '#/definitions/SecurityAssessment' patch: description: 'Patches one or more findings in the specified template baseline type security assessment. Use it to modify max allowed risk level in template baseline. ' operationId: PatchFindings parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The findings will be updated in the specified template baseline type security assessment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more findings in the specified security assessment. tags: - dataSafe x-example: "PATCH /20181201/securityAssessments/{securityAssessmentId}/findings \n{\n \"items\": \n [{\n \"operation\" : \"MERGE\",\n \"selection\": \"items[?key='USER.APPOWNER']\",\n \"value\" : {\n \"severity\": \"LOW\"\n }\n },\n {\n \"operation\" : \"REMOVE\",\n \"selection\": \"items[?key='USER.INACTIVE']\",\n \"value\" : {\n \"severity\": \"MEDIUM\"\n }\n }]\n}\n" x-related-resource: '#/definitions/SecurityAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchFindingsDetails' description: Details to patch findings. required: true /securityAssessments/{securityAssessmentId}/findings/{findingKey}: put: description: Updates one or more attributes of the specified finding. operationId: UpdateFinding parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/FindingKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The finding will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified finding. tags: - dataSafe x-related-resource: '#/definitions/Finding' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFindingDetails' description: Details to change risk of a finding. required: true /securityAssessments/{securityAssessmentId}/findingsChangeAuditLogs: get: description: 'List all changes made by user to risk level of findings of the specified assessment. ' operationId: ListFindingsChangeAuditLogs parameters: - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/SeverityQueryParam' - $ref: '#/components/parameters/FindingKeyQueryParam' - $ref: '#/components/parameters/FindingTitleQueryParam' - $ref: '#/components/parameters/isRiskDeferredQueryParam' - $ref: '#/components/parameters/ModifiedByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FindingsRiskChangeSortByQueryParam' - $ref: '#/components/parameters/TimeValidUntilGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeValidUntilLessThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'An array containing the changes to risk levels if any for findings for the specified security assessment. ' headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FindingsChangeAuditLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List all risk level changes made by user for findings for the specified assessment. ' tags: - dataSafe x-related-resource: '#/definitions/SecurityAssessment' /securityAssessments/{securityAssessmentId}/templateBaselineComparison/{comparisonSecurityAssessmentId}: get: description: Gets the details of the comparison report for the security assessments submitted for comparison. operationId: GetTemplateBaselineComparison parameters: - $ref: '#/components/parameters/SecurityAssessmentIdPathParam' - $ref: '#/components/parameters/ComparisonSecurityAssessmentIdPathParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/CategoryQueryParam' - $ref: '#/components/parameters/FindingKeyQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists the details of the comparison report. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string x-example: application-json: "{\n \"id\": \"ocid1.datasafesecurityassessment.oc1.iad.abuwcljrvvhfrzfssouuzx4nbn55oqmp5bqodl6v2rtr3ew47z3yxngxtwsa\",\n \"templateBaselineId\": \"ocid1.datasafesecurityassessment.oc1.iad.amaaaaaagn3s2faatg7ginfy7jpyxt6kz2goqdq3lwojl56dc3oee6qhyeha\",\n \"lifecycleState\": \"CREATING\",\n \"timeCreated\": \"2024-05-16T15:53:59.924Z\",\n \"dataEncryption\": [\n {\n \"baseline\": {\n \"severity\": \"EVALUATE\",\n \"key\": \"ENCRYPT.TDE\",\n \"title\": \"Transparent Data Encryption\"\n },\n \"targets\": [\n {\n \"severity\": \"HIGH\",\n \"key\": \"ENCRYPT.TDE\",\n \"title\": \"Transparent Data Encryption\",\n \"targetId\": \"ocid1.datasafetargetdatabase.oc1.iad.abuwcljrvmlgg2eehvxxggn5jm4yefnttvjxz2bencn3dvxhxs6gzffkfxfq\"\n },\n {\n \"severity\": \"LOW\",\n \"key\": \"ENCRYPT.TDE\",\n \"title\": \"Transparent Data Encryption\",\n \"targetId\": \"ocid1.datasafetargetdatabase.oc1.iad.abuwclcfdydht2vpbko6kezmcx7p2nrlx2e2c3jxtr24czsz4ofzojyxnddf\"\n }\n ]\n }\n ]\n}\n" content: application/json: schema: $ref: '#/components/schemas/SecurityAssessmentTemplateBaselineComparison' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the comparison report for the provided security assessments. tags: - dataSafe x-example: 'GET /20181201/securityAssessments/<securityAssessmentId>/templateBaselineComparison/<comparisonSecurityAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAssessment' /securityPolicies: get: description: '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. ' operationId: ListSecurityPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityPolicyTypeQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policies retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all security policies. tags: - dataSafe x-example: 'GET /20181201/securityPolicies Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a Data Safe security policy. ' operationId: CreateSecurityPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The security policy will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the security policy. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a security policy. tags: - dataSafe requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityPolicyDetails' description: Details of the security policy. required: true /securityPolicies/{securityPolicyId}: delete: description: Deletes the specified security policy. operationId: DeleteSecurityPolicy parameters: - $ref: '#/components/parameters/SecurityPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The security policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified security policy. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicy' get: description: Gets a security policy by the specified OCID of the security policy resource. operationId: GetSecurityPolicy parameters: - $ref: '#/components/parameters/SecurityPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a security policy by the specified OCID of the security policy resource. tags: - dataSafe x-example: 'GET /20181201/securityPolicies/{securityPolicyId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the security policy. operationId: UpdateSecurityPolicy parameters: - $ref: '#/components/parameters/SecurityPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The security policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the security policy. tags: - dataSafe x-example: "PUT /20181201/securityPolicies/{securityPolicyId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"SecurityPolicy_updated\",\n \"description\" : \"Updated security policy description\"\n}\n" x-related-resource: '#/definitions/SecurityPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityPolicyDetails' description: Details to update the security policy. required: true /securityPolicies/{securityPolicyId}/actions/changeCompartment: post: description: Moves the specified security policy and its dependent resources into a different compartment. operationId: ChangeSecurityPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityPolicyIdPathParam' responses: 202: description: Request received successfully. The security policy will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified security policy and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/securityPolicies/{securityPolicyId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SecurityPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityPolicyCompartmentDetails' description: Details for the compartment move. required: true /securityPolicyConfigs: get: description: 'Retrieves a list of all security policy configurations in Data Safe. The ListSecurityPolicyConfigs operation returns only the security policy 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 ListSecurityPolicyConfigs 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. ' operationId: ListSecurityPolicyConfigs parameters: - $ref: '#/components/parameters/SecurityPolicyConfigIdQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityPolicyConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy configurations retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyConfigCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all security policy configurations. tags: - dataSafe post: description: 'Creates a new security policy configuration resource. ' operationId: CreateSecurityPolicyConfig parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the security policy config. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new security policy configuration resource. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicyConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityPolicyConfigDetails' description: Details of the security policy configuration. required: true /securityPolicyConfigs/{securityPolicyConfigId}: delete: description: Deletes the specified Security policy configuration. operationId: DeleteSecurityPolicyConfig parameters: - $ref: '#/components/parameters/SecurityPolicyConfigIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Security policy configuration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified Security policy configuration. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicyConfig' get: description: Gets a security policy configuration by identifier. operationId: GetSecurityPolicyConfig parameters: - $ref: '#/components/parameters/SecurityPolicyConfigIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy configuration retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a security policy configuration by identifier. tags: - dataSafe x-example: 'GET /20181201/securityPolicyConfigs/{securityPolicyConfigId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the security policy configuration. operationId: UpdateSecurityPolicyConfig parameters: - $ref: '#/components/parameters/SecurityPolicyConfigIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The security policy configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the security policy configuration. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicyConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityPolicyConfigDetails' description: Details to update the security policy configuration. required: true /securityPolicyConfigs/{securityPolicyConfigId}/actions/changeCompartment: post: description: Moves the specified security policy configuration and its dependent resources into a different compartment. operationId: ChangeSecurityPolicyConfigCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityPolicyConfigIdPathParam' responses: 202: description: Request received successfully. The security policy configuration will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified security policy configuration and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/securityPolicyConfigs/{securityPolicyConfigId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SecurityPolicyConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityPolicyConfigCompartmentDetails' description: Details for the compartment move. required: true /securityPolicyDeployments: get: description: '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. ' operationId: ListSecurityPolicyDeployments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyDeploymentLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityPolicyDeploymentIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/SecurityPolicyDeploymentTargetTypeQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy deployments retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyDeploymentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all security policy deployments. tags: - dataSafe x-example: 'GET /20181201/securityPolicyDeployments Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a Data Safe security policy deployment in the Data Safe Console. ' operationId: CreateSecurityPolicyDeployment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The security policy deployment will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the security policy deployment. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyDeployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a security policy deployment in the Data Safe Console. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicyDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityPolicyDeploymentDetails' description: Details of the security policy deployment. required: true /securityPolicyDeployments/{securityPolicyDeploymentId}: delete: description: Deletes the specified Security policy deployment. operationId: DeleteSecurityPolicyDeployment parameters: - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Security policy deployment will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified Security policy deployment. tags: - dataSafe x-related-resource: '#/definitions/SecurityPolicyDeployment' get: description: Gets a security policy deployment by identifier. operationId: GetSecurityPolicyDeployment parameters: - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: security policy deployment retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyDeployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a security policy deployment by identifier. tags: - dataSafe x-example: 'GET /20181201/securityPolicyDeployments/{securityPolicyDeploymentId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the security policy deployment. operationId: UpdateSecurityPolicyDeployment parameters: - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The security policy deployment will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the security policy deployment. tags: - dataSafe x-example: "PUT /20181201/securityPolicyDeployments/{securityPolicyDeploymentId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"SecurityPolicyDeployment_updated\",\n \"description\" : \"Updated security policy deployment description\"\n}\n" x-related-resource: '#/definitions/SecurityPolicyDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityPolicyDeploymentDetails' description: Details to update the security policy deployment. required: true /securityPolicyDeployments/{securityPolicyDeploymentId}/actions/changeCompartment: post: description: Moves the specified security policy deployment and its dependent resources into a different compartment. operationId: ChangeSecurityPolicyDeploymentCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' responses: 202: description: Request received successfully. The security policy deployment will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified security policy deployment and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/securityPolicyDeployments/{securityPolicyDeploymentId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SecurityPolicyDeployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityPolicyDeploymentCompartmentDetails' description: Details for the compartment move. required: true /securityPolicyDeployments/{securityPolicyDeploymentId}/actions/deploy: post: description: Deploy the security policy to the specified target or target groups. operationId: DeploySecurityPolicyDeployment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' responses: 202: description: Request received successfully. The security policy deployment will be deployed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Deploy the security policy. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityPolicyDeployment' /securityPolicyDeployments/{securityPolicyDeploymentId}/actions/refresh: post: description: Retrieve all the security policies from the associated target or target group and refresh the same on Data safe. operationId: RefreshSecurityPolicyDeployment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' responses: 202: description: Request received successfully. The security policy deployment will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refresh the security policy deployment. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityPolicyDeployment' /securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates: get: description: '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. ' operationId: ListSecurityPolicyEntryStates parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyEntryStateDeploymentStatusQueryParam' - $ref: '#/components/parameters/SecurityPolicyEntryIdQueryParam' - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' - $ref: '#/components/parameters/SecurityPolicyEntryTypeQueryParam' - $ref: '#/components/parameters/SecurityPolicyEntryTargetIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy entry states retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyEntryStateCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all security policy entry states. tags: - dataSafe x-example: 'GET /20181201/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates/{securityPolicyEntryStateId}: get: description: Gets a security policy entity states by identifier. operationId: GetSecurityPolicyEntryState parameters: - $ref: '#/components/parameters/SecurityPolicyDeploymentIdPathParam' - $ref: '#/components/parameters/SecurityPolicyEntryStateIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: security policy entity state retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyEntryState' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a security policy entity states by identifier. tags: - dataSafe x-example: 'GET /20181201/securityPolicyDeployments/{securityPolicyDeploymentId}/securityPolicyEntryStates/{securityPolicyEntryStateId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports: get: description: '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. ' operationId: ListSecurityPolicyReports parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyReportLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityPolicyReportIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy reports retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all security policy reports. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}: get: description: Gets a security policy report by the specified OCID of the security policy report resource. operationId: GetSecurityPolicyReport parameters: - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Security policy report retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityPolicyReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a security policy report by the specified OCID of the security policy report resource. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries: get: description: '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. ' operationId: ListDatabaseTableAccessEntries parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/SecurityPolicyReportSCIMQueryParam' - $ref: '#/components/parameters/TableAccessEntrySortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database table access reports retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseTableAccessEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all database table access entries. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries/{databaseTableAccessEntryKey}: get: description: Gets a database table access entry object by identifier. operationId: GetDatabaseTableAccessEntry parameters: - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/DatabaseTableAccessEntryKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database table access object retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseTableAccessEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a database table access entry object by identifier. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId}/databaseTableAccessEntries/{databaseTableAccessEntryKey} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries: get: description: '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. If targetId is specified, it must match the target associated with the securityPolicyReportId path parameter; otherwise, the request is rejected. ' operationId: ListDatabaseViewAccessEntries parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/SecurityPolicyReportSCIMQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/ViewAccessEntrySortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database view access entries retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseViewAccessEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all database view access objects. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId}/ListDatabaseViewAccessEntries Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries/{databaseViewAccessEntryKey}: get: description: Gets a database view access object by identifier. operationId: GetDatabaseViewAccessEntry parameters: - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/DatabaseViewAccessEntryKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Database view access object retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseViewAccessEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a database view access object by identifier. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId}/databaseViewAccessEntries/{databaseViewAccessEntryKey} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /securityPolicyReports/{securityPolicyReportId}/roleGrantPaths: get: description: '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. ' operationId: ListRoleGrantPaths parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyReportIdPathParam' - $ref: '#/components/parameters/GranteeQueryParam' - $ref: '#/components/parameters/GrantedRoleQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Grant path retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RoleGrantPathCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all role grant paths for a user. tags: - dataSafe x-example: 'GET /20181201/securityPolicyReports/{securityPolicyReportId}/roleGrantPaths Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sensitiveColumnAnalytics: get: description: 'Gets consolidated sensitive columns analytics data based on the specified query parameters. When you perform the ListSensitiveColumnAnalytics 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. To use ListSensitiveColumnAnalytics 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. ' operationId: ListSensitiveColumnAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdsQueryParam' - $ref: '#/components/parameters/SensitiveTypeGroupIdQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/SensitiveColumnGroupByQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive column analytics data retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveColumnAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets consolidated sensitive column analytics data based on the specified query parameters. tags: - dataSafe x-example: "GET /20181201/sensitiveColumnAnalytics?groupBy=targetId\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"dimensions\": {\n \"targetId\": \"ocid1.datasafetargetdatabase.oc1.iad.exampleuniqueID\",\n \"schemaName\": \"HR\",\n \"objectName\": \"EMPLOYEES\",\n \"columnName\": \"EMPLOYEE_ID\"\n },\n \"count\": 1\n}\n" x-related-resource: '#/definitions/SensitiveDataModel' /sensitiveDataModels: get: description: 'Gets a list of sensitive data models based on the specified query parameters. ' operationId: ListSensitiveDataModels parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SensitiveDataModelIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveDataModelSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DiscoveryLifecycleStateQueryParam' responses: 200: description: Sensitive data models retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveDataModelCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of sensitive data models. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' post: description: '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. ' operationId: CreateSensitiveDataModel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The sensitive data model is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the sensitive data model. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveDataModel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSensitiveDataModelDetails' description: Details to create a new sensitive data model. required: true /sensitiveDataModels/{sensitiveDataModelId}: delete: description: Deletes the specified sensitive data model. operationId: DeleteSensitiveDataModel parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive data model will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' get: description: Gets the details of the specified sensitive data model. operationId: GetSensitiveDataModel parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive data model retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveDataModel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified sensitive data model. tags: - dataSafe put: description: '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. ' operationId: UpdateSensitiveDataModel parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive data model will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSensitiveDataModelDetails' description: Details to update a sensitive data model. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/changeCompartment: post: description: Moves the specified sensitive data model and its dependent resources into a different compartment. operationId: ChangeSensitiveDataModelCompartment parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Sensitive data model moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified sensitive data model and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSensitiveDataModelCompartmentDetails' description: Details to change the compartment of a sensitive data model. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/download: post: description: '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. ' operationId: DownloadSensitiveDataModel parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive data model downloaded successfully. headers: content-length: description: The size of the sensitive data model file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Downloads an already-generated file corresponding to the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadSensitiveDataModelDetails' description: Details to download a sensitive data model file. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/downloadReport: post: description: '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. ' operationId: DownloadDiscoveryReport parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' responses: 200: description: Discovery report downloaded successfully. headers: content-length: description: The size of the discovery report file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Downloads an already-generated discovery report for the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadDiscoveryReportDetails' description: Details to download a discovery report. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/generateDataModelForDownload: post: description: '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. ' operationId: GenerateSensitiveDataModelForDownload parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive data model file will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Generates a downloadable file corresponding to the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateSensitiveDataModelForDownloadDetails' description: Details to generate a sensitive data model file. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/generateReportForDownload: post: description: '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. ' operationId: GenerateDiscoveryReportForDownload parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' responses: 202: description: Request received successfully. The discovery report will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Generates a downloadable discovery report. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateDiscoveryReportForDownloadDetails' description: Details to generate a downloadable discovery report. required: true /sensitiveDataModels/{sensitiveDataModelId}/actions/upload: post: description: '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. ' operationId: UploadSensitiveDataModel parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive data model will be uploaded. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Uploads a sensitive data model file to update the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: format: binary type: string description: Details to upload a sensitive data model file. required: true /sensitiveDataModels/{sensitiveDataModelId}/referentialRelations: get: description: 'Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters. ' operationId: ListReferentialRelations parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/IsSensitiveQueryParam' - $ref: '#/components/parameters/RelationTypeQueryParam' - $ref: '#/components/parameters/ReferentialRelationsPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ReferentialRelationsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Referential relations retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReferentialRelationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters. tags: - dataSafe x-example: "GET /sensitiveDataModels/ocid1.sensitivedatamodel.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/referentialRelations {\n \"items\": \n [{ \"key\": \"1234\",\n \"sensitiveDataModelId\": \"ocid1.sensitivedatamodel.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a\",\n \"lifecycleState\": \"CREATING\",\n \"relationType\": \"APP_DEFINED\"\n \"parent\":\n {\n \"schemaName\":\"TEST\",\n \"objectType\":\"TABLE\",\n \"objectName\":\"PURCHASE\",\n \"appName\":\"TEST_APPLICATION\",\n \"columnGroup\":[\"customer_id\", \"product_code\"]\n },\n \"child\": {\n \"schemaName\":\"TEST\",\n \"objectType\":\"TABLE\",\n \"objectName\":\"ORDER\",\n \"appName\":\"TEST_APPLICATION\",\n \"columnGroup\":[\"customer_id\", \"product_code\"]\n },\n]}\n" x-related-resource: '#/definitions/ReferentialRelation' post: description: 'Creates a new referential relation in the specified sensitive data model. ' operationId: CreateReferentialRelation parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The referential relation is being created in the specified sensitive data model. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new referential relation in the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/ReferentialRelation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReferentialRelationDetails' description: Details to create a new referential relation. required: true /sensitiveDataModels/{sensitiveDataModelId}/referentialRelations/{referentialRelationKey}: delete: description: Deletes the specified referential relation. operationId: DeleteReferentialRelation parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/ReferentialRelationKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Referential relation deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified referential relation. tags: - dataSafe x-related-resource: '#/definitions/ReferentialRelation' get: description: Gets the details of the specified referential relation. operationId: GetReferentialRelation parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/ReferentialRelationKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Referential relation retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReferentialRelation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified referential relation. tags: - dataSafe /sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns: get: description: 'Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters. ' operationId: ListSensitiveColumns parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanQueryParam' - $ref: '#/components/parameters/SensitiveColumnLifecycleStateQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/DataTypeQueryParam' - $ref: '#/components/parameters/StatusQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdsQueryParam' - $ref: '#/components/parameters/ParentColumnKeyQueryParam' - $ref: '#/components/parameters/RelationTypeQueryParam' - $ref: '#/components/parameters/ColumnGroupQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveColumnSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsCaseInSensitive' responses: 200: description: Sensitive columns retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveColumnCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/SensitiveColumn' patch: description: '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. ' operationId: PatchSensitiveColumns parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive columns will be patched in the specified sensitive data model. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more columns in the specified sensitive data model. tags: - dataSafe x-example: "PATCH /sensitiveDataModels/ocid1.sensitivedatamodel.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/sensitiveColumns {\n \"items\": \n [{ \"operation\": \"INSERT\",\n \"selection\": \"items\",\n \"value\":\n {\n \"appName\":\"TEST_APPLICATION\",\n \"schemaName\":\"HR\",\n \"objectName\":\"TABLE1\",\n \"objectType\":\"TABLE\",\n \"columnName\":\"US_SSN\",\n \"dataType\":\"CHAR\",\n \"status\":\"VALID\",\n \"relationType\": \"NONE\"\n }\n },\n { \"operation\": \"INSERT\",\n \"selection\": \"items\",\n \"value\":\n {\n \"appName\":\"TEST_APPLICATION\",\n \"schemaName\":\"HR\",\n \"objectName\":\"TABLE2\",\n \"objectType\":\"TABLE\",\n \"columnName\":\"US_PHONE\",\n \"dataType\":\"CHAR\",\n \"status\":\"VALID\",\n \"relationType\": \"NONE\"\n }\n }]\n}\nPATCH /sensitiveDataModels/ocid1.sensitivedatamodel.oc1.phx.abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a/sensitiveColumns { \n \"items\":\n [{ \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='620']\", \n \"value\":{\n \"sensitiveTypeId\": \"ocid1.sensitivetype.oc1.phx.abuxgljr6l2nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a\"\n }\n },\n { \"operation\": \"MERGE\",\n \"selection\": \"items[?key=='710']\", \n \"value\":{ \n \"status\":\"INVALID\"\n }\n }\n ]\n} \n" x-related-resource: '#/definitions/SensitiveColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchSensitiveColumnDetails' description: Details to patch sensitive columns. required: true post: description: 'Creates a new sensitive column in the specified sensitive data model. ' operationId: CreateSensitiveColumn parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive column is being created in the specified sensitive data model. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new sensitive column in the specified sensitive data model. tags: - dataSafe x-related-resource: '#/definitions/SensitiveColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSensitiveColumnDetails' description: Details to create a new sensitive column. required: true /sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/actions/applyDiscoveryJobResults: post: description: '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. ' operationId: ApplyDiscoveryJobResults parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The discovery results will be applied. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Applies the results of a discovery job to the specified sensitive data model. tags: - dataSafe x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SensitiveDataModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyDiscoveryJobResultsDetails' description: Details to apply the discovery results to a sensitive data model. required: true /sensitiveDataModels/{sensitiveDataModelId}/sensitiveColumns/{sensitiveColumnKey}: delete: description: Deletes the specified sensitive column. operationId: DeleteSensitiveColumn parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SensitiveColumnKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Sensitive column deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified sensitive column. tags: - dataSafe x-related-resource: '#/definitions/SensitiveColumn' get: description: Gets the details of the specified sensitive column. operationId: GetSensitiveColumn parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SensitiveColumnKeyPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive column retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveColumn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified sensitive column. tags: - dataSafe put: description: Updates one or more attributes of the specified sensitive column. operationId: UpdateSensitiveColumn parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SensitiveColumnKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive column will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sensitive column. tags: - dataSafe x-related-resource: '#/definitions/SensitiveColumn' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSensitiveColumnDetails' description: Details to update a sensitive column. required: true /sensitiveDataModels/{sensitiveDataModelId}/sensitiveObjects: get: description: 'Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters. ' operationId: ListSensitiveObjects parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveObjectSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive objects retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters. tags: - dataSafe /sensitiveDataModels/{sensitiveDataModelId}/sensitiveSchemas: get: description: 'Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters. ' operationId: ListSensitiveSchemas parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveSchemaSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive schemas retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveSchemaCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters. tags: - dataSafe /sensitiveDataModels/{sensitiveDataModelId}/sensitiveTypes: get: description: 'Gets a list of sensitive type Ids present in the specified sensitive data model. ' operationId: ListSensitiveDataModelSensitiveTypes parameters: - $ref: '#/components/parameters/SensitiveDataModelIdPathParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/SensitiveDataModelSensitiveTypesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive Types for the specified SDM retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveDataModelSensitiveTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive type Ids present in the specified sensitive data model. tags: - dataSafe /sensitiveTypeGroups: get: description: 'Gets a list of sensitive type groups based on the specified query parameters. ' operationId: ListSensitiveTypeGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SensitiveTypeGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/SensitiveTypeGroupIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveTypeGroupSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of sensitive type groups. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypeGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive type groups based on the specified query parameters. tags: - dataSafe x-example: 'GET /20181201/sensitiveTypeGroups Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SensitiveTypeGroupSummary' post: description: 'Creates a new sensitive type group. ' operationId: CreateSensitiveTypeGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive type group will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the sensitive type group. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypeGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new sensitive type group. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypeGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSensitiveTypeGroupDetails' description: Details of the sensitive type group. required: true /sensitiveTypeGroups/{sensitiveTypeGroupId}: delete: description: Deletes the specified sensitive type group. operationId: DeleteSensitiveTypeGroup parameters: - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive type group will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified sensitive type group. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypeGroup' get: description: 'Gets the details of the specified sensitive type group. ' operationId: GetSensitiveTypeGroup parameters: - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the sensitive type group. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypeGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified sensitive type group. tags: - dataSafe x-example: 'GET /20181201/sensitiveTypeGroups/{sensitiveTypeGroupId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SensitiveTypeGroup' put: description: Updates one or more attributes of the specified sensitive type group. operationId: UpdateSensitiveTypeGroup parameters: - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The sensitive type group will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sensitive type group. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypeGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSensitiveTypeGroupDetails' description: Details used to update the sensitive type group. required: true /sensitiveTypeGroups/{sensitiveTypeGroupId}/actions/changeCompartment: post: description: Moves the sensitive type group to the specified compartment. operationId: ChangeSensitiveTypeGroupCompartment parameters: - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The Sensitive type group is moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the sensitive type group to the specified compartment. tags: - dataSafe x-example: "POST /20160918/sensitiveTypeGroups/{sensitiveTypeGroupId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SensitiveTypeGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSensitiveTypeGroupCompartmentDetails' description: Details of the move compartment request. required: true /sensitiveTypeGroups/{sensitiveTypeGroupId}/groupedSensitiveTypes: get: description: 'Gets the list of sensitive type Ids present in the specified sensitive type group. ' operationId: ListGroupedSensitiveTypes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Sensitive types for the specified sensitive type group retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GroupedSensitiveTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Sensitive types for the specified sensitive type group retrieved successfully. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypeGroup' patch: description: 'Patches one or more sensitive types in a sensitive type group. You can use this operation to add or remove sensitive type ids in a sensitive type group. ' operationId: PatchGroupedSensitiveTypes parameters: - $ref: '#/components/parameters/SensitiveTypeGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive type ids will be patched in the sensitive type group. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Patches one or more sensitive types in a sensitive type group. tags: - dataSafe x-example: "PATCH /sensitiveTypeGroups/ocid1.sensitivetypegroup.oc1.iad.exampleuniqueID/groupedSensitiveTypes {\n \"items\":\n [{ \"operation\": \"INSERT\",\n \"selection\": \"items\"\n \"value\":\n {\n \"sensitiveTypeId\":\"ocid1.datasafesensitivetype.oc1.iad.exampleuniqueID\"\n }\n },\n { \"operation\": \"REMOVE\",\n \"selection\": \"items[sensitiveTypeId=='ocid1.datasafesensitivetype.oc1.iad.exampleuniqueID']\"\n } ]\n}\n} \n" x-related-resource: '#/definitions/SensitiveTypeGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchGroupedSensitiveTypesDetails' description: Details to patch sensitive type ids in a SensitiveTypeGroup. required: true /sensitiveTypes: get: description: 'Gets a list of sensitive types based on the specified query parameters. ' operationId: ListSensitiveTypes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SensitiveTypeIdQueryParam' - $ref: '#/components/parameters/SensitiveTypeSourceQueryParam' - $ref: '#/components/parameters/EntityTypeQueryParam' - $ref: '#/components/parameters/ParentCategoryIdQueryParam' - $ref: '#/components/parameters/DefaultMaskingFormatIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SensitiveTypeSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DiscoveryLifecycleStateQueryParam' - $ref: '#/components/parameters/IsCommonSensitiveTypeQueryParam' responses: 200: description: Sensitive types retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of sensitive types based on the specified query parameters. tags: - dataSafe x-related-resource: '#/definitions/SensitiveType' post: description: '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. ' operationId: CreateSensitiveType parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The sensitive type is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the sensitive type. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveType' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new sensitive type. tags: - dataSafe requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSensitiveTypeDetails' description: Details to create a new sensitive type. required: true /sensitiveTypes/actions/bulkCreateSensitiveTypes: post: description: 'Uploads a sensitive types xml file (also called template) to create new sensitive types. ' operationId: BulkCreateSensitiveTypes parameters: - $ref: '#/components/parameters/CompartmentIdHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive types will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Uploads a sensitive types xml file to create new sensitive types in regions. tags: - dataSafe x-related-resource: '#/definitions/SensitiveType' requestBody: content: application/json: schema: format: binary type: string description: Details to upload a sensitive types file and create all. required: true /sensitiveTypes/{sensitiveTypeId}: delete: description: Deletes the specified sensitive type. operationId: DeleteSensitiveType parameters: - $ref: '#/components/parameters/SensitiveTypeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Sensitive type deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified sensitive type. tags: - dataSafe x-related-resource: '#/definitions/SensitiveType' get: description: Gets the details of the specified sensitive type. operationId: GetSensitiveType parameters: - $ref: '#/components/parameters/SensitiveTypeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive type retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveType' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified sensitive type. tags: - dataSafe put: description: Updates one or more attributes of the specified sensitive type. operationId: UpdateSensitiveType parameters: - $ref: '#/components/parameters/SensitiveTypeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive type will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sensitive type. tags: - dataSafe x-related-resource: '#/definitions/SensitiveType' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSensitiveTypeDetails' description: Details to update a sensitive type. required: true /sensitiveTypes/{sensitiveTypeId}/actions/changeCompartment: post: description: Moves the specified sensitive type into a different compartment. operationId: ChangeSensitiveTypeCompartment parameters: - $ref: '#/components/parameters/SensitiveTypeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Sensitive type moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified sensitive type into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/SensitiveType' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSensitiveTypeCompartmentDetails' description: Details to change the compartment of a sensitive type. required: true /sensitiveTypesExports: get: description: 'Retrieves a list of all sensitive types export in Data Safe based on the specified query parameters. The ListSensitiveTypesExports operation returns only the sensitive types export in the specified `compartmentId`. ' operationId: ListSensitiveTypesExports parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SensitiveTypesExportLifecycleStateQueryParam' - $ref: '#/components/parameters/SensitiveTypesExportIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive types export retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypesExportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all sensitive types export based on the specified query parameters. tags: - dataSafe x-example: 'GET /20181201/SensitiveTypesExports Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: "Generates a downloadable file corresponding to the specified list of sensitive types. It's a prerequisite for the\nDownloadSensitiveTypesExport operation. Use this endpoint to generate a sensitive Types Export file and then use \nDownloadSensitiveTypesExport to download the generated file.\n" operationId: CreateSensitiveTypesExport parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive types for export is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: The URI of the sensitive types export. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypesExport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Generates a downloadable file corresponding to the specified list of sensitive types. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypesExport' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSensitiveTypesExportDetails' description: Details to create a new sensitive types export resource. required: true /sensitiveTypesExports/{sensitiveTypesExportId}: delete: description: Deletes the specified sensitive types export. operationId: DeleteSensitiveTypesExport parameters: - $ref: '#/components/parameters/SensitiveTypesExportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Sensitive types export deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified sensitive types export. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypesExport' get: description: Gets the details of the specified sensitive types export by identifier. operationId: GetSensitiveTypesExport parameters: - $ref: '#/components/parameters/SensitiveTypesExportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive types export retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SensitiveTypesExport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified sensitive types export by identifier. tags: - dataSafe x-example: 'GET /20181201/sensitiveTypesExports/{sensitiveTypesExportId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates one or more attributes of the specified sensitive types export. operationId: UpdateSensitiveTypesExport parameters: - $ref: '#/components/parameters/SensitiveTypesExportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The sensitive types export will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified sensitive types export. tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypesExport' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSensitiveTypesExportDetails' description: Details to update a sensitive type. required: true /sensitiveTypesExports/{sensitiveTypesExportId}/actions/changeCompartment: post: description: Moves the specified sensitive types export into a different compartment. operationId: ChangeSensitiveTypesExportCompartment parameters: - $ref: '#/components/parameters/SensitiveTypesExportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Sensitive types export moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified sensitive types export into a different compartment. tags: - dataSafe x-example: "POST /20160918/sensitiveTypesExports/{sensitiveTypesExportId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SensitiveTypesExport' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSensitiveTypesExportCompartmentDetails' description: Details to change the compartment of a sensitive types export. required: true /sensitiveTypesExports/{sensitiveTypesExportId}/actions/download: post: description: 'Downloads an already-generated file corresponding to the specified sensitive types export. Use CreateSensitiveTypesExport to generate an XML file and then use DownloadSensitiveTypesExport to download the generated file. ' operationId: DownloadSensitiveTypesExport parameters: - $ref: '#/components/parameters/SensitiveTypesExportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Sensitive types for export downloaded successfully. headers: content-length: description: The size of the sensitive types for export file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Downloads an already-generated file corresponding to the specified sensitive types export tags: - dataSafe x-related-resource: '#/definitions/SensitiveTypesExport' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadSensitiveTypesExportDetails' description: Details to download a sensitive types export file. required: true /sqlCollectionAnalytics: get: description: '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. ' operationId: ListSqlCollectionAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SqlCollectionLifecycleStateQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SqlCollectionGroupByQueryParam' - $ref: '#/components/parameters/SqlCollectionTimeStartQueryParam' - $ref: '#/components/parameters/SqlCollectionTimeEndQueryParam' responses: 200: description: SQL collection analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlCollectionAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all SQL collections. tags: - dataSafe x-example: 'GET /20181201/sqlCollectionAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlCollections: get: description: '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. ' operationId: ListSqlCollections parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SqlCollectionLifecycleStateQueryParam' - $ref: '#/components/parameters/SqlCollectionIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' - $ref: '#/components/parameters/SqlCollectionUserNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SqlCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL collections retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlCollectionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all SQL collections. tags: - dataSafe x-example: 'GET /20181201/SqlCollections Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new SQL collection resource. ' operationId: CreateSqlCollection parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. SQL collection will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the SQL collection. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new SQL collection resource. tags: - dataSafe x-example: "POST /20181201/targetDatabases\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\":\"SampleSqlCollection\",\n \"description\":\"Sample SqlCollection description\",\n \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"dbUserName\": \"user1\",\n \"sqlLevel\": \"ALL_SQL\"\n \"status\": \"ENABLED\",\n \"targetId\": \"ocid1.datasafetargetdatabase.oc1.iad.abuwclcfdydht2vpbko6kezmcx7p2nrlx2e2c3jxtr24czsz4ofzojyxnddf\",\n \"freeformTags\" : {\n \"tagKey\" : \"value\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"key\" : \"value\"\n }\n }\n}\n" x-related-resource: '#/definitions/SqlCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSqlCollectionDetails' description: Details of the SQL collection. required: true /sqlCollections/{sqlCollectionId}: delete: description: Deletes the specified SQL collection. operationId: DeleteSqlCollection parameters: - $ref: '#/components/parameters/SqlCollectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The SQL collection will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified SQL collection. tags: - dataSafe x-related-resource: '#/definitions/SqlCollection' get: description: Gets a SQL collection by identifier. operationId: GetSqlCollection parameters: - $ref: '#/components/parameters/SqlCollectionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL collection retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a SQL collection by identifier. tags: - dataSafe x-example: 'GET /20181201/sqlCollections/{sqlCollectionId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the SQL collection. operationId: UpdateSqlCollection parameters: - $ref: '#/components/parameters/SqlCollectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The SQL collection will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the SQL collection. tags: - dataSafe x-example: "PUT /20181201/sqlCollections/{sqlCollectionId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"SqlCollection_updated\",\n \"description\" : \"Updated SQL collection description\"\n}\n" x-related-resource: '#/definitions/SqlCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSqlCollectionDetails' description: Details to update the SQL collection. required: true /sqlCollections/{sqlCollectionId}/actions/changeCompartment: post: description: Moves the specified SQL collection and its dependent resources into a different compartment. operationId: ChangeSqlCollectionCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL collection will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified SQL collection and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/sqlCollections/{sqlCollectionId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SqlCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSqlCollectionCompartmentDetails' description: Details for the compartment move. required: true /sqlCollections/{sqlCollectionId}/actions/generateSqlFirewallPolicy: post: description: Generates or appends to the SQL Firewall policy using the specified SQL collection. operationId: GenerateSqlFirewallPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL Firewall policy will be generated/appended using the specified SQL collection. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Generates or appends to the SQL Firewall policy using the specified SQL collection. tags: - dataSafe x-example: 'POST /20160918/sqlCollections/{sqlCollectionId}/actions/generateSqlFirewallPolicy Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SqlCollection' /sqlCollections/{sqlCollectionId}/actions/purgeLogs: post: description: Purge the SQL collection logs for the specified SqlCollection. operationId: PurgeSqlCollectionLogs parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL collection logs will be purged. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Purge the SQL collection logs for the specified SqlCollection. tags: - dataSafe x-example: 'POST /20160918/sqlCollections/{sqlCollectionId}/actions/purgeLogs Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SqlCollection' /sqlCollections/{sqlCollectionId}/actions/refreshLogInsights: post: description: Refresh the specified SQL collection Log Insights. operationId: RefreshSqlCollectionLogInsights parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL collection log insights will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refresh the specified SQL collection Log Insights. tags: - dataSafe x-example: 'POST /20160918/sqlCollections/{sqlCollectionId}/actions/refreshLogInsights Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SqlCollection' /sqlCollections/{sqlCollectionId}/actions/start: post: description: Start the specified SQL collection. operationId: StartSqlCollection parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL collection will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Starts the specified SQL collection. tags: - dataSafe x-example: 'POST /20160918/sqlCollections/{sqlCollectionId}/actions/start Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/sqlCollection' /sqlCollections/{sqlCollectionId}/actions/stop: post: description: Stops the specified SQL collection. operationId: StopSqlCollection parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlCollectionIdPathParam' responses: 202: description: Request received successfully. The SQL collection will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Stops the specified SQL collection. tags: - dataSafe x-example: 'POST /20160918/sqlCollections/{sqlCollectionId}/actions/stop Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SqlCollection' /sqlCollections/{sqlCollectionId}/logInsights: get: description: 'Retrieves a list of the SQL collection log analytics. ' operationId: ListSqlCollectionLogInsights parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SqlCollectionLogInsightsTimeStartQueryParam' - $ref: '#/components/parameters/SqlCollectionLogInsightsTimeEndQueryParam' - $ref: '#/components/parameters/SqlCollectionIdPathParam' - $ref: '#/components/parameters/SqlCollectionLogGroupByQueryParam' responses: 200: description: SQL collection log analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlCollectionLogInsightsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all SQL collections. tags: - dataSafe x-example: 'GET /20181201/sqlCollections/{sqlCollectionId}/logInsights Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlFirewallAllowedSqlAnalytics: get: description: '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. ' operationId: ListSqlFirewallAllowedSqlAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SqlFirewallAllowedSqlSCIMQueryParam' - $ref: '#/components/parameters/SqlFirewallAllowedSqlGroupByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL Firewall allow SQL statements aggregates retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallAllowedSqlAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the aggregation details of all SQL Firewall allowed SQL statements. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallAllowedSqlAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlFirewallAllowedSqls: get: description: '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. ' operationId: ListSqlFirewallAllowedSqls parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SqlFirewallAllowedSqlSCIMQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SqlFirewallAllowedSqlSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL Firewall allowed SQL statements retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallAllowedSqlCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all SQL Firewall allowed SQL statements. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallAllowedSqls Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' patch: description: 'Delete multiple allowed sqls. You can use this operation to delete one or more allowed sqls. Create and update of multiple allowed sqls is not supported. ' operationId: PatchSqlFirewallAllowedSql parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The allowed sqls will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete multiple allowed sqls. tags: - dataSafe x-example: "PATCH /20181201/sqlFirewallAllowedSqls\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sqlFirewallPolicyId\" : \"ocid1.datasafesqlfirewallpolicy.oc1.iad.abuwcljrwoni5ifjjgatptjelawaqy7sjk6wyjqv6t4rjfvxry5n3gjjgqjq\",\n \"items\":[\n {\n \"operation\":\"REMOVE\",\n \"selection\":\"items[?id=='ocid1.datasafesqlfirewallallowedsql.oc1.iad.anuwcljr3p47bsaahurdt5d236yofq5v2cueuntxqyqgda5lqhpqx3wzjztq']\"\n },\n {\n \"operation\":\"REMOVE\",\n \"selection\":\"items[?id=='ocid1.datasafesqlfirewallallowedsql.oc1.iad.abuwcljrc5jzhtlt6uvc266i74ls57hc5kthkiquuqikay2ff7hst43vs5qa']\"\n }\n ]\n}\n" x-related-resource: '#/definitions/SqlFirewallAllowedSql' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchSqlFirewallAllowedSqlDetails' description: The details used to patch the allowed sqls. required: true /sqlFirewallAllowedSqls/actions/bulkCreate: post: description: Appends the allowedSqls with entries from the logs. operationId: BulkCreateSqlFirewallAllowedSqls parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. Allowed sqls will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Appends the allowedSqls with entries from the logs. tags: - dataSafe x-example: "POST /20160918/sqlFirewallAllowedSqls/actions/bulkCreate\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sqlFirewallPolicyId\" : \"ocid1.datasafesqlfirewallpolicy.oc1.iad.abuwcljrwoni5ifjjgatptjelawaqy7sjk6wyjqv6t4rjfvxry5n3gjjgqjq\",\n \"logType\" : \"VIOLATION_LOG\",\n \"selection\" : {\n \"selectionMode\" : \"SCIM_QUERY\",\n \"scimQuery\" : (dbUserName eq \"PAY_APP\")\n }\n}\nPOST /20160918/sqlFirewallAllowedSqls/actions/bulkCreate\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sqlFirewallPolicyId\" : \"ocid1.datasafesqlfirewallpolicy.oc1.iad.abuwcljrwoni5ifjjgatptjelawaqy7sjk6wyjqv6t4rjfvxry5n3gjjgqjq\",\n \"logType\" : \"VIOLATION_LOG\",\n \"selection\" : {\n \"selectionMode\" : \"LIST\",\n \"items\" : ['ocid1.datasafesqlfirewallviolation.oc1.iad.anuwcljr3p47bsaahurdt5d236yofq5v2cueuntxqyqgda5lqhpqx3wzjztq', 'ocid1.datasafesqlfirewallviolation.oc1.iad.abuwcljrc5jzhtlt6uvc266i74ls57hc5kthkiquuqikay2ff7hst43vs5qa']\n }\n}\n" x-related-resource: '#/definitions/SqlFirewallAllowedSql' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkCreateSqlFirewallAllowedSqlsDetails' description: Details of the allowed sql. required: true /sqlFirewallAllowedSqls/actions/bulkDelete: post: description: Delete multiple allowed sqls from the SQL firewall policy. operationId: BulkDeleteSqlFirewallAllowedSqls parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Allowed sqls will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Delete multiple allowed sqls. tags: - dataSafe x-example: "POST /20160918/sqlFirewallAllowedSqls/actions/bulkDelete\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sqlFirewallPolicyId\" : \"ocid1.datasafesqlfirewallpolicy.oc1.iad.abuwcljrwoni5ifjjgatptjelawaqy7sjk6wyjqv6t4rjfvxry5n3gjjgqjq\",\n \"selection\" : {\n \"selectionMode\" : \"SCIM_QUERY\",\n \"scimQuery\" : (dbUserName eq \"PAY_APP\")\n }\n}\nPOST /20160918/sqlFirewallAllowedSqls/actions/bulkDelete\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sqlFirewallPolicyId\" : \"ocid1.datasafesqlfirewallpolicy.oc1.iad.abuwcljrwoni5ifjjgatptjelawaqy7sjk6wyjqv6t4rjfvxry5n3gjjgqjq\",\n \"selection\" : {\n \"selectionMode\" : \"LIST\",\n \"items\" : ['ocid1.datasafesqlfirewallallowedsql.oc1.iad.anuwcljr3p47bsaahurdt5d236yofq5v2cueuntxqyqgda5lqhpqx3wzjztq', 'ocid1.datasafesqlfirewallallowedsql.oc1.iad.abuwcljrc5jzhtlt6uvc266i74ls57hc5kthkiquuqikay2ff7hst43vs5qa']\n }\n}\n" x-related-resource: '#/definitions/SqlFirewallAllowedSql' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDeleteSqlFirewallAllowedSqlsDetails' description: Details of the allowed sql to be deleted from the SQL firewall policy. required: true /sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId}: delete: description: Deletes the specified allowed sql. operationId: DeleteSqlFirewallAllowedSql parameters: - $ref: '#/components/parameters/SqlFirewallAllowedSqlIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The allowed sql will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified allowed sql. tags: - dataSafe x-related-resource: '#/definitions/SqlFirewallAllowedSql' get: description: Gets a SQL firewall allowed SQL by identifier. operationId: GetSqlFirewallAllowedSql parameters: - $ref: '#/components/parameters/SqlFirewallAllowedSqlIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL firewall allowed SQL retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallAllowedSql' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a SQL firewall allowed SQL by identifier. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallAllowedSqls/{sqlFirewallAllowedSqlId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlFirewallPolicies: get: description: '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. ' operationId: ListSqlFirewallPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyIdQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyUserNameQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyViolationActionQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL Firewall policies retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all SQL Firewall policies. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallPolicies Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlFirewallPolicies/{sqlFirewallPolicyId}: delete: description: 'Deletes the SQL Firewall policy resource. ' operationId: DeleteSqlFirewallPolicy parameters: - $ref: '#/components/parameters/SqlFirewallPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. SQL Firewall policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the SQL Firewall policy. tags: - dataSafe x-related-resource: '#/definitions/SqlFirewallPolicy' get: description: Gets a SQL Firewall policy by identifier. operationId: GetSqlFirewallPolicy parameters: - $ref: '#/components/parameters/SqlFirewallPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: SQL Firewall policy retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a SQL Firewall policy by identifier. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallPolicies/{sqlFirewallPolicyId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the SQL Firewall policy. operationId: UpdateSqlFirewallPolicy parameters: - $ref: '#/components/parameters/SqlFirewallPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The SQL Firewall policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the SQL Firewall policy. tags: - dataSafe x-example: "PUT /20181201/sqlFirewallPolicies/{sqlFirewallPolicyId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n {\n \"displayName\" : \"samplePolicy\",\n \"description\" : \"sample SQL Firewall policy\",\n \"status\": \"ENABLED\",\n \"enforcementScope\": \"ENFORCE_CONTEXT\",\n \"violationAction\": \"BLOCK\",\n \"violationAudit\": \"ENABLED\"\n \"allowedClientIps\":[\"192.168.1.23\"],\n \"allowedClientOsUsernames\":[\"TEST_USER\"],\n \"allowedClientPrograms\":[\"TEST_PROGRAM\"]\n }\n" x-related-resource: '#/definitions/SqlFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSqlFirewallPolicyDetails' description: Details to update the SQL Firewall policy. required: true /sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment: post: description: Moves the specified SQL Firewall policy and its dependent resources into a different compartment. operationId: ChangeSqlFirewallPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SqlFirewallPolicyIdPathParam' responses: 202: description: Request received successfully. The SQL Firewall policy will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified SQL Firewall policy and its dependent resources into a different compartment. tags: - dataSafe x-example: "POST /20160918/sqlFirewallPolicies/{sqlFirewallPolicyId}/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/SqlFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSqlFirewallPolicyCompartmentDetails' description: Details for the compartment move. required: true /sqlFirewallPolicyAnalytics: get: description: '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. ' operationId: ListSqlFirewallPolicyAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyGroupByQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyTimeStartQueryParam' - $ref: '#/components/parameters/SqlFirewallPolicyTimeEndQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully summarized SQL Firewall policy information. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallPolicyAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarizes the SQL Firewall policy information. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallPolicyAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /sqlFirewallViolationAnalytics: get: description: 'Returns the aggregation details of the SQL Firewall violations. ' operationId: ListSqlFirewallViolationAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TimeStartQueryParam' - $ref: '#/components/parameters/TimeEndQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationSummarySortByQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationSCIMQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationSummaryFieldQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationGroupByQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A page of SQL Firewall violations aggregation objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallViolationAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the aggregation details of the SQL Firewall violations. tags: - dataSafe x-example: "GET /20181201/sqlFirewallViolationAnalytics?groupBy=targetName\n {\n \"items\": [\n { \"metricName\": \"SQL_VIOLATIONS\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:40\",\n \"count\": 3,\n \"dimensions\": {\n \"targetName\": \"target_1\"\n }\n },\n { \"metricName\": \"CONTEXT_VIOLATIONS\" ,\n \"timeStarted\": \"2021-05-25T00:00:00\",\n \"timeEnded\": \"2021-05-26T00:00:00\",\n \"count\": 4,\n \"dimensions\": {\n \"targetName\": \"target_1\",\n }\n }\n ]\n }\n" x-related-resource: '#/definitions/SqlFirewallViolationSummary' /sqlFirewallViolations: get: description: 'Gets a list of all the SQL Firewall violations captured by the firewall. ' operationId: ListSqlFirewallViolations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationSortByQueryParam' - $ref: '#/components/parameters/SqlFirewallViolationSCIMQueryParam' responses: 200: description: SQL Firewall violations retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlFirewallViolationsCollection' application/xml: schema: $ref: '#/components/schemas/SqlFirewallViolationsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the SQL Firewall violations captured by the firewall. tags: - dataSafe x-example: 'GET /20181201/sqlFirewallViolations Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SqlFirewallViolationSummary' /targetAlertPolicyAssociations: get: description: 'Gets a list of all target-alert policy associations. ' operationId: ListTargetAlertPolicyAssociations parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdQueryParam' - $ref: '#/components/parameters/AlertPolicyIdQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AlertPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TargetAlertPolicyAssociationSortByQueryParam' - $ref: '#/components/parameters/AlertPolicyAssociationTargetTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: Target alert policy associations retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetAlertPolicyAssociationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all target-alert policy associations. tags: - dataSafe x-example: 'GET /20181201/targetAlertPolicyAssociations Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetAlertPolicyAssociationSummary' patch: description: 'Creates new target-alert policy associations that will be applied on the target database. ' operationId: PatchTargetAlertPolicyAssociation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The alert policies will be associated to the targets. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates new target-alert policy associations that will be applied on the target database. tags: - dataSafe x-example: "PATCH /20181201/targetAlertPolicyAssociations\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\",\n \"items\":[\n {\n \"operation\":\"INSERT\",\n \"selection\":\"items\",\n \"value\":{\n \"policyId\":\"ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw\",\n \"targetId\":\"ocid1.datasafeinstance.target.dev2.arsgk6rrajbnicptestyf1a58zng0ukwarqeuedcuzdxy32gakkkuzesasew\",\n \"isEnabled\":true,\n \"freeformTags\":{\n \"env\":\"dev\",\n \"val\":\"testing\"\n },\n \"definedTags\":{\n \"defined\":{\n \"use\":\"datasafe\"\n }\n }\n }\n },\n {\n \"operation\":\"INSERT\",\n \"selection\":\"items\",\n \"value\":{\n \"policyId\":\"ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yoktgr\",\n \"targetId\":\"ocid1.datasafeinstance.target.dev2.arsgk6rrajbnicptestyf1a58zng0ukwarqeuedcuzdxy32gakkkuzesalog\",\n \"isEnabled\":true,\n \"freeformTags\":{\n \"env\":\"dev2\",\n \"val\":\"testing\"\n },\n \"definedTags\":{\n \"defined\":{\n \"use\":\"datasafe\"\n }\n }\n }\n }\n ]\n}\n" x-related-resource: '#/definitions/TargetAlertPolicyAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchTargetAlertPolicyAssociationDetails' description: The details used to patch the target-alert policy associations. required: true post: description: 'Creates a new target-alert policy association to track a alert policy applied on target. ' operationId: CreateTargetAlertPolicyAssociation parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Reqeust received successfully. The target alert policy association is being created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the target-alert policy association. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetAlertPolicyAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new target-alert policy association to track a alert policy applied on target. tags: - dataSafe x-example: "POST /20181201/targetAlertPolicyAssociations\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"policyId\": \"ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw\",\n \"targetId\": \"ocid1.datasafeinstance.target.dev2.arsgk6rrajbnicptestyf1a58zng0ukwarqeuedcuzdxy32gakkkuzesasew\",\n \"isEnabled\": TRUE,\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"freeformTags\" : {\n \"env\": \"dev\",\n \"val\" : \"testing\"\n },\n \"definedTags\" : {\n \"defined\": {\"use\": \"datasafe\"}\n }\n}\n" x-related-resource: '#/definitions/TargetAlertPolicyAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTargetAlertPolicyAssociationDetails' description: The details used to create a new target-alert policy association. required: true /targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}: delete: description: Deletes the specified target-alert policy Association. operationId: DeleteTargetAlertPolicyAssociation parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The target-alert policy Association will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified target-alert policy Association. tags: - dataSafe x-example: 'DELETE /20160918/targetAlertPolicyAssociations/<id> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetAlertPolicyAssociation' get: description: Gets the details of target-alert policy association by its ID. operationId: GetTargetAlertPolicyAssociation parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Target alert policy association for the given ID retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetAlertPolicyAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified target-alert policy association. tags: - dataSafe x-example: 'GET /20181201/targetAlertPolicyAssociations/<id> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetAlertPolicyAssociation' put: description: Updates the specified target-alert policy association. operationId: UpdateTargetAlertPolicyAssociation parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The target alert policy Association will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the specified target-alert policy association. tags: - dataSafe x-related-resource: '#/definitions/TargetAlertPolicyAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetAlertPolicyAssociationDetails' description: The details used to update the target-alert policy association. required: true /targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/actions/changeCompartment: post: description: Moves the specified target-alert policy Association into a different compartment. operationId: ChangeTargetAlertPolicyAssociationCompartment parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Target-Alert policy association moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the specified target-alert policy association into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/TargetAlertPolicyAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTargetAlertPolicyAssociationCompartmentDetails' description: The details used to change the compartment of a target-alert policy association. required: true /targetAlertPolicyAssociations/{targetAlertPolicyAssociationId}/unassociatedTargetMembers: get: description: Gets the details of target-alert policy association and its unassociated members by its ID. operationId: ListTargetAlertPolicyUnassociatedMembers parameters: - $ref: '#/components/parameters/TargetAlertPolicyAssociationIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/UnassociatedTargetMemberSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Target alert policy association and its unassociated members for the given ID retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetAlertPolicyUnassociatedCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified target-alert policy association and its unassociated members. tags: - dataSafe x-example: 'GET /20181201/targetAlertPolicyAssociations/<id>/unassociatedTargetMembers Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetAlertPolicyAssociation' /targetDatabaseGroups: get: description: 'Retrieves a list of target database groups according to the specified query parameters. ' operationId: ListTargetDatabaseGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/FilterQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupsSortByQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupsLifecycleStateQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' responses: 200: description: List of target database groups. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDatabaseGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of target database groups according to the specified query parameters. tags: - dataSafe x-example: 'GET /20181201/targetDatabaseGroups Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetDatabaseGroupSummary' post: description: 'Creates a new target database group. ' operationId: CreateTargetDatabaseGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The target database group is created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDatabaseGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new target database group. tags: - dataSafe x-example: "POST /20181201/targetDatabaseGroups?compartmentId={compartmentId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestGroup\",\n \"compartmentId\": \"ocid1.compartment.oc1.your_targetgroup_compartment_id\",\n \"description\": \"Description of the target database group (optional).\",\n \"matchingCriteria\": {\n \"include\": {\n \"compartments\": [ {id:\"ocid1.compartment.oc1..your_compartment_id_1\"},\n {id:\"ocid1.compartment.oc1..your_compartment_id_2\", isIncludeSubtree : true}\n ],\n \"targetDatabaseIds\": [\"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_1\",\n \"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_2\"],\n \"definedTags\": {\n \"mbanappa_tag\": {\"listing\":\"test\"},\n \"dbspmo\": {\"LastAccessed\":\"your.email@oracle.com\"}\n },\n \"freeformTags\": {\n \"testKey\":\"TestValue\",\n \"testKey2\":\"TestValue2\"\n }\n },\n \"exclude\": {\n \"targetDatabaseIds\": [\"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_3\"]\n }\n }\n" x-related-resource: '#/definitions/TargetDatabaseGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTargetDatabaseGroupDetails' description: Details of the target database group. required: true /targetDatabaseGroups/{targetDatabaseGroupId}: delete: description: Deletes the specified target database group. operationId: DeleteTargetDatabaseGroup parameters: - $ref: '#/components/parameters/TargetDatabaseGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The target database group is scheduled for deletion. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified target database group. tags: - dataSafe x-related-resource: '#/definitions/TargetDatabaseGroup' get: description: 'Returns the details of the specified target database group. ' operationId: GetTargetDatabaseGroup parameters: - $ref: '#/components/parameters/TargetDatabaseGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the target database group. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDatabaseGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the details of the specified target database group. tags: - dataSafe x-example: 'GET /20181201/targetDatabaseGroups/{targetDatabaseGroupId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetDatabaseGroup' put: description: Updates one or more attributes of the specified target database group. operationId: UpdateTargetDatabaseGroup parameters: - $ref: '#/components/parameters/TargetDatabaseGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The target database group is scheduled for update. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified target database group. tags: - dataSafe x-example: "PUT /20181201/targetDatabaseGroups/{targetDatabaseGroupId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestGroup_UpdateGroup\",\n \"description\": \"Description of the target database group (optional).\",\n \"matchingCriteria\": {\n \"include\": {\n \"compartments\": [ {id:\"ocid1.compartment.oc1..your_compartment_id_1\"},\n {id:\"ocid1.compartment.oc1..your_compartment_id_2\", isIncludeSubtree : true}\n ],\n \"targetDatabaseIds\": [\"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_1\",\n \"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_2\"],\n \"definedTags\": {\n \"mbanappa_tag\": {\"listing\":\"test\"},\n \"dbspmo\": {\"LastAccessed\":\"your.email@oracle.com\"}\n },\n \"freeformTags\": {\n \"testKey\":\"TestValue\",\n \"testKey2\":\"TestValue2\"\n }\n },\n \"exclude\": {\n \"targetDatabaseIds\": [\"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_3\"]\n }\n }\n" x-related-resource: '#/definitions/TargetDatabaseGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetDatabaseGroupDetails' description: Details used to update the target database group. required: true /targetDatabaseGroups/{targetDatabaseGroupId}/actions/changeCompartment: post: description: Moves the target database group to the specified compartment. operationId: ChangeTargetDatabaseGroupCompartment parameters: - $ref: '#/components/parameters/TargetDatabaseGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The Target Database Group will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the target database group to the specified compartment. tags: - dataSafe x-example: "POST /20160918/targetDatabaseGroups/<targetDatabaseGroupId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/TargetDatabaseGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTargetDatabaseGroupCompartmentDetails' description: Details of the move compartment request. required: true /targetDatabaseGroups/{targetDatabaseGroupId}/groupMembers: get: description: 'Retrieves the members of the target database group with the specified OCID. ' operationId: GetGroupMembers parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseGroupIdPathParam' - $ref: '#/components/parameters/MembershipIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: OCIDs of the target database group members. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/GroupMembersCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the members of the target database group with the specified OCID. tags: - dataSafe x-example: "GET /20181201/targetDatabaseGroups/{targetDatabaseGroupId}/groupMembers\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n \"string\"\n ]\n}\n" x-related-resource: '#/definitions/TargetDatabaseGroup' /targetDatabases: get: description: 'Returns the list of registered target databases in Data Safe. ' operationId: ListTargetDatabases parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AssociatedResourceIdQueryParam' - $ref: '#/components/parameters/TargetDatabaseIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TargetDatabaseLifecycleStateQueryParam' - $ref: '#/components/parameters/DatabaseTypeQueryParam' - $ref: '#/components/parameters/InfrastructureTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of registered target databases in Data Safe. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/TargetDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the list of registered target databases in Data Safe. tags: - dataSafe x-example: 'GET /20181201/targetDatabases Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console. ' operationId: CreateTargetDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The database is registered with Data Safe and the target database is created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the target database. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Registers the specified database with Data Safe and creates a target database in the Data Safe Console. tags: - dataSafe x-example: "POST /20181201/targetDatabases\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : null,\n \"description\" : null,\n \"databaseDetails\" : {\n \"databaseType\" : \"CLOUD_DB_SYSTEM\",\n \"dbSystemdId\" : \"ocid1.dbsystem.oc1.iad.<unique_ID>\",\n \"serviceName\" : \"database.host.com\"\n },\n \"credentials\" : null,\n \"tlsConfig\" : null,\n \"connectionOption\" : null,\n \"freeformTags\" : {\n \"tagKey\" : \"value\"\n },\n \"definedTags\" : {\n \"tagKey\" : {\n \"key\" : \"value\"\n }\n }\n}\n" x-related-resource: '#/definitions/TargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTargetDatabaseDetails' description: Details of the target database. required: true /targetDatabases/{targetDatabaseId}: delete: description: Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console. operationId: DeleteTargetDatabase parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The target database is deregistered from Data Safe and will be removed from the Data Safe Console. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 204: description: The target database is deregistered from Data Safe and will be removed from the Data Safe Console. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console. tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' get: description: 'Returns the details of the specified Data Safe target database. ' operationId: GetTargetDatabase parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the target database. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TargetDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the details of the specified Data Safe target database. tags: - dataSafe x-example: 'GET /20181201/targetDatabases/{targetDatabaseId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates one or more attributes of the specified Data Safe target database. operationId: UpdateTargetDatabase parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The target database is updated in Data Safe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified Data Safe target database. tags: - dataSafe x-example: "PUT /20181201/targetDatabases/{targetDatabaseId}\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"updated-name\",\n \"description\" : \"updated-description\",\n \"databaseDetails\" : null,\n \"credentials\" : {\n \"userName\" : \"databaseAdminUser\",\n \"password\" : \"\"\n },\n \"tlsConfig\" : null,\n \"connectionOption\" : null,\n \"freeformTags\" : null,\n \"definedTags\" : null\n}\n" x-related-resource: '#/definitions/TargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetDatabaseDetails' description: Details used to update the target database in Data Safe. required: true /targetDatabases/{targetDatabaseId}/actions/activate: post: description: 'Reactivates a previously deactivated Data Safe target database. ' operationId: ActivateTargetDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The target database is reactivated in Data Safe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Reactivates a previously deactivated Data Safe target database. tags: - dataSafe x-example: 'POST /20160918/targetDatabases/<targetDatabaseId>/actions/activate Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> {} ' x-related-resource: '#/definitions/TargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateTargetDatabaseDetails' description: The details used to reactivate a target database in Data Safe. /targetDatabases/{targetDatabaseId}/actions/changeCompartment: post: description: Moves the Data Safe target database to the specified compartment. operationId: ChangeTargetDatabaseCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The Data Safe target database is moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the Data Safe target database to the specified compartment. tags: - dataSafe x-example: "POST /20160918/targetDatabases/<targetDatabaseId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/TargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTargetDatabaseCompartmentDetails' description: Details of the move compartment request. required: true /targetDatabases/{targetDatabaseId}/actions/deactivate: post: description: 'Deactivates a target database in Data Safe. ' operationId: DeactivateTargetDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The target database is deactivated in Data Safe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deactivates a target database in Data Safe. tags: - dataSafe x-example: 'POST /20160918/targetDatabases/<targetDatabaseId>/actions/deactivate Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/actions/managePrivileges: post: description: Updates the Data Safe target database Privileges. operationId: ManagePrivileges parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The Data Safe target database privileges update has been initiated successfully and will complete asynchronously. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Data Safe target database Privileges. tags: - dataSafe x-example: "POST /20160918/targetDatabases/<targetDatabaseId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"features\" : [\"ASSESSMENT\",\"AUDIT_COLLECTION\"]\n}\n" x-related-resource: '#/definitions/TargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManagePrivilegesDetails' description: Details of the manage target database privileges request. required: true /targetDatabases/{targetDatabaseId}/actions/refresh: post: description: 'Refreshes the Data Safe target database to update it''s state. ' operationId: RefreshTargetDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The target database state is refreshed in Data Safe. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Refreshes the Data Safe target database to update it's state. tags: - dataSafe x-example: 'POST /20160918/targetDatabases/<targetDatabaseId>/actions/refresh Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/actions/refreshDictionaryObjects: post: description: 'Refreshes the dictionary data of the target database. ' operationId: RefreshTargetDatabaseDictionaryObjects parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted. Dictionary Objects will be refreshed from the target database. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Refresh dictionary data for the Data Safe target database. tags: - dataSafe x-example: 'POST /20160918/targetDatabases/<targetDatabaseId>/actions/refreshDictionaryObjects Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/columns: get: description: 'Returns a list of column metadata objects. ' operationId: ListColumns parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/TableNameQueryParam' - $ref: '#/components/parameters/ColumnNameQueryParam' - $ref: '#/components/parameters/DatatypeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ColumnListSortByQueryParam' - $ref: '#/components/parameters/SchemaNameContainsQueryParam' - $ref: '#/components/parameters/TableNameContainsQueryParam' - $ref: '#/components/parameters/ColumnNameContainsQueryParam' responses: 200: description: A page of column metadata objects retrieved from the registered database. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ColumnSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List metadata of columns from all the tables in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter. ' tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/dictionary: get: description: 'Returns dictionary. ' operationId: GetDictionary parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of dictionary object retrieved from the registered database. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DictionarySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets the date and time the dictionary objects were last fetched from the database. The target database is identified by id supplied as a path parameter. ' tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/peerTargetDatabases: get: description: Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter. operationId: ListPeerTargetDatabases parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Summary of the peer target database details associated to the primary target database specified in the path parameter. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PeerTargetDatabaseCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter. tags: - dataSafe x-example: 'GET /20181201/targetDatabases/{targetDatabaseId}/peerTargetDatabases Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PeerTargetDatabase' post: description: Creates the peer target database under the primary target database in Data Safe. operationId: CreatePeerTargetDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: The database is registered with Data Safe and the peer target database is added to the target database. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the peer target database. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PeerTargetDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates the peer target database under the primary target database in Data Safe. tags: - dataSafe x-example: "POST /20160918/targetDatabases/<targetDatabaseId>/peerTargetDatabases\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n{\n \"displayName\" : \"standby\",\n \"dataGuardAssociationId\" : \"\",\n \"databaseDetails\" : {\n \"databaseType\" : \"DATABASE_CLOUD_SERVICE\",\n \"infrastructureType\" : \"ORACLE_CLOUD\",\n \"dbSystemId\" : \"\",\n \"listenerPort\" : 1628,\n \"serviceName\" : \"DB12s_pdb1.sub11.pevcn.oraclevcn.com\"\n },\n \"tlsConfig\" : {\n \"status\" : \"ENABLED\",\n \"certificateStoreType\" : \"JKS\",\n \"storePassword\" : \"\",\n \"trustStoreContent\" : \"\",\n \"keyStoreContent\" : null\n }\n}\n" x-related-resource: '#/definitions/PeerTargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePeerTargetDatabaseDetails' description: Database details used to create the peer target database under the primary target database. required: true /targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId}: delete: description: Removes the specified peer target database from Data Safe. operationId: DeletePeerTargetDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/PeerTargetDatabaseIdPathParam' responses: 202: description: The Data Safe peer target database is removed successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes the specified peer target database from Data Safe. tags: - dataSafe x-example: 'DELETE /20160918/targetDatabases/<targetDatabaseId>/peerTargetDatabases/<peerTargetDatabaseId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/PeerTargetDatabase' get: description: 'Returns the details of the specified Data Safe peer target database. ' operationId: GetPeerTargetDatabase parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/PeerTargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the peer target database. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PeerTargetDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns the details of the specified Data Safe peer target database. tags: - dataSafe x-example: 'GET /20181201/targetDatabases/{targetDatabaseId}/peerTargetDatabases/{peerTargetDatabaseId} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates one or more attributes of the specified Data Safe peer target database. operationId: UpdatePeerTargetDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/PeerTargetDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The Data Safe peer target database is updated successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified Data Safe peer target database. tags: - dataSafe x-example: "PUT /20160918/targetDatabases/<targetDatabaseId>/peerTargetDatabases/<peerTargetDatabaseId>\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"standby\",\n \"databaseDetails\" : {\n \"listenerPort\" : 1628,\n \"serviceName\" : \"DB12s_pdb1.sub11.pevcn.oraclevcn.com\"\n },\n \"tlsConfig\" : {\n \"status\" : \"ENABLED\",\n \"certificateStoreType\" : \"JKS\",\n \"storePassword\" : \"\",\n \"trustStoreContent\" : \"\",\n \"keyStoreContent\" : null\n }\n}\n" x-related-resource: '#/definitions/PeerTargetDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePeerTargetDatabaseDetails' description: Database details to be used to update the peer target database. required: true /targetDatabases/{targetDatabaseId}/roles: get: description: 'Returns a list of role metadata objects. ' operationId: ListRoles parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RoleNameQueryParam' - $ref: '#/components/parameters/RoleTypeQueryParam' - $ref: '#/components/parameters/RoleAuthTypeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RoleListSortByQueryParam' - $ref: '#/components/parameters/RoleNameContainsQueryParam' responses: 200: description: A page of role metadata objects retrieved from the registered database. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RoleSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List metadata of roles in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter. ' tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/schemas: get: description: 'Returns list of schema. ' operationId: ListSchemas parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SchemaListSortByQueryParam' - $ref: '#/components/parameters/SchemaTypeQueryParam' - $ref: '#/components/parameters/SchemaNameContainsQueryParam' responses: 200: description: A page of schema retrieved from the database represented by the target database. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SchemaSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List metadata of schema present in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter. ' tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' /targetDatabases/{targetDatabaseId}/tables: get: description: 'Returns a list of table metadata objects. ' operationId: ListTables parameters: - $ref: '#/components/parameters/TargetDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SchemaNameQueryParam' - $ref: '#/components/parameters/TableNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TableListSortByQueryParam' - $ref: '#/components/parameters/TableNameContainsQueryParam' - $ref: '#/components/parameters/SchemaNameContainsQueryParam' responses: 200: description: A page of table metadata objects retrieved from the registered database. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/TableSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List metadata of tables in the database registered as a target database in Data Safe console. The target database is identified by id supplied as a path parameter. ' tags: - dataSafe x-related-resource: '#/definitions/TargetDatabase' /unifiedAuditPolicies: get: description: 'Retrieves a list of all Unified Audit policies. The ListUnifiedAuditPolicies operation returns only the Unified Audit policies in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requester has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a sub-compartment) 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 ListUnifiedAuditPolicies 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 sub-compartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. ' operationId: ListUnifiedAuditPolicies parameters: - $ref: '#/components/parameters/SecurityPolicyIdQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsSeededPoliciesQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Unified Audit policies retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnifiedAuditPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all Unified Audit policies. tags: - dataSafe post: description: 'Creates the specified unified audit policy. ' operationId: CreateUnifiedAuditPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. Unified audit policy will be created. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'The full URI of the unified audit policy. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnifiedAuditPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates the specified unified audit policy. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUnifiedAuditPolicyDetails' description: Details required to create the unified audit policy. required: true /unifiedAuditPolicies/actions/bulkCreate: post: description: Bulk create unified audit policies. operationId: BulkCreateUnifiedAuditPolicy parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request received successfully. The Unified Audit policy will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Bulk create unified audit policies. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkCreateUnifiedAuditPolicyDetails' description: Details for the compartment move. required: true /unifiedAuditPolicies/{unifiedAuditPolicyId}: delete: description: 'Deletes the Unified Audit policy resource. ' operationId: DeleteUnifiedAuditPolicy parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. Unified Audit policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the Unified Audit policy. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicy' get: description: Gets a Unified Audit policy by identifier. operationId: GetUnifiedAuditPolicy parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Unified Audit policy retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnifiedAuditPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a Unified Audit policy by identifier. tags: - dataSafe put: description: Updates the Unified Audit policy. operationId: UpdateUnifiedAuditPolicy parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Unified Audit policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Unified Audit policy. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUnifiedAuditPolicyDetails' description: Details required to update the Unified Audit policy. required: true /unifiedAuditPolicies/{unifiedAuditPolicyId}/actions/changeCompartment: post: description: Moves the specified Unified Audit policy and its dependent resources into a different compartment. operationId: ChangeUnifiedAuditPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/UnifiedAuditPolicyIdPathParam' responses: 202: description: Request received successfully. The Unified Audit policy will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified Unified Audit policy and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeUnifiedAuditPolicyCompartmentDetails' description: Details for the compartment move. required: true /unifiedAuditPolicyDefinitions: get: description: 'Retrieves a list of all unified audit policy definitions in Data Safe. The ListUnifiedAuditPolicyDefinitions operation returns only the unified audit policy definitions in the specified `compartmentId`. The parameter `accessLevel` specifies whether to return only those compartments for which the requester 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 ListUnifiedAuditPolicyDefinitions 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. ' operationId: ListUnifiedAuditPolicyDefinitions parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionLifecycleStateQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IsSeededPolicyDefinitionsQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyCategoryQueryParam' - $ref: '#/components/parameters/UnifiedAuditPolicyNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Unified audit policy definitions retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnifiedAuditPolicyDefinitionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all unified audit policy definitions. tags: - dataSafe /unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}: delete: description: Deletes the specified Unified audit policy definition. operationId: DeleteUnifiedAuditPolicyDefinition parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The Unified audit policy definition will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified Unified audit policy definition. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicyDefinition' get: description: Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource. operationId: GetUnifiedAuditPolicyDefinition parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Unified audit policy definition retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UnifiedAuditPolicyDefinition' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource. tags: - dataSafe put: description: Updates the unified audit policy definition. operationId: UpdateUnifiedAuditPolicyDefinition parameters: - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The unified audit policy definition will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the unified audit policy definition. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicyDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUnifiedAuditPolicyDefinitionDetails' description: Details to update the unified audit policy definition. required: true /unifiedAuditPolicyDefinitions/{unifiedAuditPolicyDefinitionId}/actions/changeCompartment: post: description: Moves the specified unified audit policy definition and its dependent resources into a different compartment. operationId: ChangeUnifiedAuditPolicyDefinitionCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/UnifiedAuditPolicyDefinitionIdPathParam' responses: 202: description: Request received successfully. The unified audit policy definition will be moved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified unified audit policy definition and its dependent resources into a different compartment. tags: - dataSafe x-related-resource: '#/definitions/UnifiedAuditPolicyDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeUnifiedAuditPolicyDefinitionCompartmentDetails' description: Details for the compartment move. required: true /userAssessments: get: description: '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. ' operationId: ListUserAssessments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ScheduleUserAssessmentIdQueryParam' - $ref: '#/components/parameters/IsScheduleUserAssessmentQueryParam' - $ref: '#/components/parameters/IsBaselineQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TypeQueryParam' - $ref: '#/components/parameters/TriggeredByQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/UserAssessmentLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/UserAssessmentSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentTargetTypeQueryParam' - $ref: '#/components/parameters/TargetDatabaseGroupIdQueryParam' responses: 200: description: User assessments retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/UserAssessmentSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets a list of user assessments. User assessments can be of type: LATEST, SAVED, SAVE_SCHEDULE, or COMPARTMENT. When using COMPARTMENT type, statistical information across all compartments is returned. The data is organized by category (LOW, MEDIUM, HIGH, CRITICAL) and contains the number of users, number of users with administrative roles, number of privileged users, and in how many targets. ' tags: - dataSafe x-example: 'GET /20181201/userAssessments Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new saved user assessment for a target database or target database group in a compartment. It saves the latest assessment in the specified compartment. If a schedule is passed in, this operation persists the latest assessment that exists at the defined date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' operationId: CreateUserAssessment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request received successfully. The user assessment will be created and saved. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string location: description: 'Full URI of the created user assessment. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserAssessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new saved user assessment. tags: - dataSafe x-example: "POST /20181201/userAssessments\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"targetId\" : \"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesiswk\",\n \"freeformTags\" : {\n \"env\": \"dev\",\n \"val\" : \"testing\"\n },\n\n \"definedTags\" : {\n \"defined\": {\"use\": \"datasafe\"}\n }\n}\n" x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserAssessmentDetails' description: The details used to create a new saved user assessment. required: true /userAssessments/{userAssessmentId}: delete: description: '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. ' operationId: DeleteUserAssessment parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request received successfully. The saved user assessment saved or schedule will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 204: description: User assessment deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified saved user assessment. tags: - dataSafe x-example: 'DELETE /20160918/userAssessments/<userAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' get: description: Gets a user assessment by identifier. operationId: GetUserAssessment parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: User assessment retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserAssessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified user assessment. tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: 'Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule. ' operationId: UpdateUserAssessment parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The user assessment will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string content: application-json: example: "{\n \"id\": \"ocid1.datasafeinstance.oc1.iad.userassessment.abuwcljrb2tiozolgmjjylnfcpfl226whn5x3sqg5rcy4eryq7tndwcbl4ia\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppca\",\n \"timeCreated\": \"2020-06-19T19:11:09.561Z\",\n \"timeUpdated\": \"2020-06-19T19:11:09.561Z\",\n \"lifecycleState\": \"UPDATING\",\n \"targetIds\" : [\"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesiswk\",\n \"ocid1.datasafeinstance.target.dev.absgk5rrqhzsicpsmrixf6n27eng7ukwarqeuedcuzdxy52wakgkuzesisbg\"],\n \"type\": \"SAVED\",\n \"freeformTags\": {\n \"env\": \"dev\",\n \"val\": \"testing\"\n },\n \"definedTags\": {\n \"defined\": {\n \"use\": \"datasafe\"\n }\n }\n}\n" 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates one or more attributes of the specified user assessment. tags: - dataSafe x-example: "PUT /20181201/userAssessments/<userAssessmentId>\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"FusionApps_Q1\"\n}\n" x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserAssessmentDetails' description: The information to be updated. required: true /userAssessments/{userAssessmentId}/actions/changeCompartment: post: description: '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. ' operationId: ChangeUserAssessmentCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' responses: 204: description: User assessment moved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves the specified saved user assessment or future scheduled assessments into a different compartment. tags: - dataSafe x-example: "POST /20160918/userAssessments/<userAssessmentId>/actions/changeCompartment\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeUserAssessmentCompartmentDetails' description: The details used to change the compartment of a user assessment. required: true /userAssessments/{userAssessmentId}/actions/compare: post: description: '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. ' operationId: CompareUserAssessment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 201: description: Request received successfully. The user assessment comparison is being created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Compares user assessments. tags: - dataSafe x-example: 'POST /20181201/<userAssessmentId>/actions/compare Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompareUserAssessmentDetails' description: Details of the user assessment comparison. required: true /userAssessments/{userAssessmentId}/actions/downloadReport: post: description: '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). ' operationId: DownloadUserAssessmentReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' responses: 200: description: User assessment report retrieved successfully. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Downloads the report of the specified user assessment. tags: - dataSafe x-example: 'POST /20181201/userAssessments/<userAssessmentId>/actions/downloadReport Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadUserAssessmentReportDetails' description: Details of the report. required: true /userAssessments/{userAssessmentId}/actions/generateReport: post: description: '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. ' operationId: GenerateUserAssessmentReport parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' responses: 202: description: The request is accepted. The user assessment report will be generated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Generates the report of the specified user assessment. tags: - dataSafe x-example: 'POST /20181201/userAssessments/<userAssessmentId>/actions/generateReport Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateUserAssessmentReportDetails' description: Details of the report. required: true /userAssessments/{userAssessmentId}/actions/refresh: post: description: '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. ' operationId: RefreshUserAssessment parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 201: description: Received request successfully. The user assessment will be performed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Runs a user assessment, updates the latest assessment, and saves it for future reference. tags: - dataSafe x-example: 'POST /20181201/userAssessment/<userAssessmentId>/actions/refresh Host: datasafe.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/RunUserAssessmentDetails' description: The details required to create an on-demand saved user assessment. required: true /userAssessments/{userAssessmentId}/actions/setBaseline: post: description: 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'. operationId: SetUserAssessmentBaseline parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' responses: 200: description: Saved user assessment successfully set as a baseline. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Sets the saved user assessment as the baseline in the compartment where the specified assessment resides. tags: - dataSafe x-example: 'POST /20181201/userAssessments/<userAssessmentId>/actions/setBaseline Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAssessmentBaseLineDetails' description: Details of user assessment that need to be updated while setting the baseline. /userAssessments/{userAssessmentId}/actions/unsetBaseline: post: description: 'Removes the baseline setting for the saved user assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource. ' operationId: UnsetUserAssessmentBaseline parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/UserAssessmentIdPathParam' responses: 200: description: Request is received successfully. The baseline setting for the saved user assessment will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline. tags: - dataSafe x-example: 'POST /20181201/userAssessments/<userAssessmentId>/actions/unsetBaseline Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnsetUserAssessmentBaselineDetails' description: Details of the target associated with the user assessment for which the user intents to unset the baseline. /userAssessments/{userAssessmentId}/comparison/{comparisonUserAssessmentId}: get: description: Gets the details of the comparison report for the user assessments submitted for comparison. operationId: GetUserAssessmentComparison parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/ComparisonUserAssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists the details of the comparison report. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserAssessmentComparison' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the comparison report for the provided user assessments. tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId>/comparison/<comparisonUserAssessmentId> Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/passwordExpiryDateAnalytics: get: description: 'Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days, and beyond 90 days based on specified user assessment. It internally uses the aforementioned userAnalytics api. When you perform the ListPasswordExpiryDateAnalytics 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 READ 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. To use ListPasswordExpiryDateAnalytics 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. ' operationId: ListPasswordExpiryDateAnalytics parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/UserCategoryQueryParam' - $ref: '#/components/parameters/TimePasswordExpiryLessThanQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: User aggregated details retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/UserAggregation' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets a list of count of the users with password expiry dates in next 30 days, between next 30-90 days and beyond 90 days based on specified user assessment. ' tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId>/passwordExpiryDateAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/profileAnalytics: get: description: '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. ' operationId: ListProfileAnalytics parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProfileNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Profiles retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ProfileAggregation' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of user profile aggregated details in the specified compartment. tags: - dataSafe x-example: 'GET /20181201/userAssessments/profileAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Profile' /userAssessments/{userAssessmentId}/profiles: get: description: '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. ' operationId: ListProfileSummaries parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProfileNameQueryParam' - $ref: '#/components/parameters/IsUserCreatedQueryParam' - $ref: '#/components/parameters/PasswordVerificationFunctionQueryParam' - $ref: '#/components/parameters/UserCountGreaterThanOrEqualQueryParam' - $ref: '#/components/parameters/UserCountLessThanQueryParam' - $ref: '#/components/parameters/FailedLoginAttemptsGreaterThanOrEqualQueryParam' - $ref: '#/components/parameters/FailedLoginAttemptsLessThanQueryParam' - $ref: '#/components/parameters/SessionsPerUserGreaterThanOrEqualQueryParam' - $ref: '#/components/parameters/SessionsPerUserLessThanQueryParam' - $ref: '#/components/parameters/InactiveAccountTimeGreaterThanOrEqualQueryParam' - $ref: '#/components/parameters/InactiveAccountTimeLessThanQueryParam' - $ref: '#/components/parameters/PasswordLockTimeGreaterThanOrEqualQueryParam' - $ref: '#/components/parameters/PasswordLockTimeLessThanQueryParam' - $ref: '#/components/parameters/UserProfileSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Profiles retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ProfileSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets a list of user profiles available on a given or all the target(s) using user assessment id in a given compartment. ' tags: - dataSafe x-example: 'GET /20181201/userAssessments/{userAssessmentId}/profiles Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/profiles/{profileName}: get: description: '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. ' operationId: GetProfile parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/ProfileNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Profile details retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Profile' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Details of given profile available on given target. ' tags: - dataSafe x-example: 'GET /20181201/userAssessments/{userAssessmentId}/profiles/{profileName} Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/userAccessAnalytics: get: description: 'Gets a list of aggregated user access analytics in the specified target in a compartment. ' operationId: ListUserAccessAnalytics parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/AccessAnalyticsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: User access analytics retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserAccessAnalyticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of user access aggregated details of the specified user assessment. tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId>/userAccessAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/userAnalytics: get: description: '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 READ 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. ' operationId: ListUserAnalytics parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/UserCategoryQueryParam' - $ref: '#/components/parameters/UserKeyQueryParam' - $ref: '#/components/parameters/AccountStatusQueryParam' - $ref: '#/components/parameters/AuthenticationTypeQueryParam' - $ref: '#/components/parameters/UserNameQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TimeLastLoginGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeLastLoginLessThanQueryParam' - $ref: '#/components/parameters/TimeUserCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUserCreatedLessThanQueryParam' - $ref: '#/components/parameters/PasswordLastChangedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/PasswordLastChangedLessThanQueryParam' - $ref: '#/components/parameters/TimePasswordExpiryGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimePasswordExpiryLessThanQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/UserSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: User aggregated details retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/UserAggregation' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of user aggregated details of the specified user assessment. tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId>/userAnalytics Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/users: get: description: '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. ' operationId: ListUsers parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/UserCategoryQueryParam' - $ref: '#/components/parameters/UserRoleQueryParam' - $ref: '#/components/parameters/UserProfileQueryParam' - $ref: '#/components/parameters/UserTypeQueryParam' - $ref: '#/components/parameters/UserKeyQueryParam' - $ref: '#/components/parameters/AccountStatusQueryParam' - $ref: '#/components/parameters/AuthenticationTypeQueryParam' - $ref: '#/components/parameters/UserNameQueryParam' - $ref: '#/components/parameters/TargetIdQueryParam' - $ref: '#/components/parameters/TimeLastLoginGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeLastLoginLessThanQueryParam' - $ref: '#/components/parameters/TimeUserCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUserCreatedLessThanQueryParam' - $ref: '#/components/parameters/PasswordLastChangedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/PasswordLastChangedLessThanQueryParam' - $ref: '#/components/parameters/TimePasswordExpiryGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimePasswordExpiryLessThanQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/UserSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SchemaListQueryParam' - $ref: '#/components/parameters/AreAllSchemasAccessibleQueryParam' responses: 200: description: Users retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/UserSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Gets a list of users of the specified user assessment. The result contains database user details such as user type, account status, last login time, user creation time, authentication type, user profile, and when was the password last changed. It also contains the user category derived from these user details and granted privileges. ' tags: - dataSafe x-example: 'GET /20181201/userAssessments/<userAssessmentId>/users Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /userAssessments/{userAssessmentId}/users/{userKey}/grants: get: description: '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. ' operationId: ListGrants parameters: - $ref: '#/components/parameters/UserAssessmentIdPathParam' - $ref: '#/components/parameters/UserKeyPathParam' - $ref: '#/components/parameters/GrantKeyQueryParam' - $ref: '#/components/parameters/GrantNameQueryParam' - $ref: '#/components/parameters/PrivilegeTypeQueryParam' - $ref: '#/components/parameters/PrivilegeCategoryQueryParam' - $ref: '#/components/parameters/DepthLevelQueryParam' - $ref: '#/components/parameters/DepthLevelGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/DepthLevelLessThanQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/GrantSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: User grants retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/GrantSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of grants for a particular user in the specified user assessment. tags: - dataSafe x-example: 'GET /20181201/userAssessments/users/<userKey>/grants Host: datasafe.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UserAssessment' /workRequests: get: description: 'Gets a list of work requests. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestOperationQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/WorkRequestSortOrderQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/WorkRequestTargetDatabaseIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' responses: 200: description: Work requests retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of work requests. tags: - dataSafe /workRequests/{workRequestId}: delete: description: 'Cancel the specified work request. ' operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Cancel request received successfully. The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer format: int32 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the specified work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequest' get: description: Gets the details of the specified work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Work request retrieved successfully. headers: etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the specified work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/actions/resume: post: description: 'Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request. ' operationId: ResumeWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The requested work request will be resumed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer format: int32 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Resume the given work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/actions/suspend: post: description: 'Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request. ' operationId: SuspendWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request received successfully. The requested work request will be suspended. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer format: int32 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Suspend the given work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Gets a list of errors for the specified work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: Work request errors retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestError' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of errors for the specified work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Gets a list of log entries for the specified work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: Log entries retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of log entries for the specified work request. tags: - dataSafe x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: SensitiveDataModelSensitiveTypeSummary: description: Summary of sensitive types present in a sensitive data model. properties: count: description: The total number of sensitive columns linked to this specific sensitive type . format: int64 type: integer sensitiveTypeId: description: The OCID of the sensitive type. maxLength: 255 minLength: 1 type: string required: - sensitiveTypeId - count type: object Diffs: description: 'Results of the comparison of an item between two security assessments. ' properties: addedItems: description: This array identifies the items that are present in the current assessment, but are missing from the baseline. items: type: string type: array baseline: $ref: '#/components/schemas/Finding' current: $ref: '#/components/schemas/Finding' modifiedItems: description: 'This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. ' items: type: string type: array removedItems: description: This array identifies the items that are present in the baseline, but are missing from the current assessment. items: type: string type: array severity: description: The severity of this diff. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string type: object CreateSensitiveTypeGroupDetails: description: The details to create a sensitive type group. properties: compartmentId: description: The OCID of the compartment where the sensitive type group should be created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type group. maxLength: 400 minLength: 1 type: string x-default-description: This field will be set to null if not provided. displayName: description: The display name of the sensitive type group. The name does not have to be unique. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format SensitiveTypeGroup_ if not provided. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object required: - compartmentId type: object MaskingAnalyticsCollection: description: A collection of masking analytics summary objects. properties: items: description: An array of masking analytics summary objects. items: $ref: '#/components/schemas/MaskingAnalyticsSummary' type: array required: - items type: object TargetAlertPolicyAssociationCollection: description: Collection of target to alert policy summary. properties: items: description: Array of target to alert policy summary items: $ref: '#/components/schemas/TargetAlertPolicyAssociationSummary' type: array required: - items type: object PatchSdmMaskingPolicyDifferenceColumnsDetails: description: Details to patch SDM masking policy difference. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object AttributeSetSummary: description: Summary details of an attribute set. properties: attributeSetType: description: The type of attribute set. type: string x-obmcs-enumref: '#/definitions/AttributeSet/attributeSetType' compartmentId: description: The OCID of the compartment that contains attribute set. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of an attribute set. maxLength: 400 minLength: 1 type: string displayName: description: The display name of an attribute set. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of an attribute set. maxLength: 255 minLength: 1 type: string inUse: description: Indicates whether the attribute set is in use by other resource. enum: - 'YES' - 'NO' type: string isUserDefined: description: Indicates whether the attribute set is user defined or pre defined in Data Safe. Values can either be 'true' or 'false'. type: boolean lifecycleState: description: The current state of an attribute set. type: string x-obmcs-enumref: '#/definitions/AttributeSet/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time an attribute set was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time an attribute set was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - attributeSetType - lifecycleState - timeCreated type: object SecurityPolicySummary: description: 'The resource represents as a container for all the security policies in Data Safe. ' properties: compartmentId: description: The OCID of the compartment containing the security policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy. enum: - CREATING - UPDATING - ACTIVE - FAILED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyLifecycleState' securityPolicyType: description: The type of the security policy. type: string x-obmcs-enumref: '#/definitions/SecurityPolicy/securityPolicyType' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time that the security policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the security policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object Finding: description: The particular finding reported by the security assessment. properties: assessmentId: description: The OCID of the assessment that generated this finding. maxLength: 255 minLength: 1 type: string details: description: The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. type: object hasTargetDbRiskLevelChanged: default: false description: Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. type: boolean isRiskModified: description: Determines if this risk level was modified by user. type: boolean justification: description: User provided reason for accepting or modifying this finding if they choose to do so. maxLength: 4000 minLength: 1 type: string key: description: A unique identifier for the finding. This is common for the finding across targets. type: string lifecycleDetails: description: Details about the current state of the finding. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the finding. enum: - ACTIVE - UPDATING - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/FindingLifecycleState' oracleDefinedSeverity: description: The severity of the finding as determined by security assessment. This cannot be modified by user. type: string x-obmcs-enumref: '#/definitions/Finding/severity' references: $ref: '#/components/schemas/References' description: Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. remarks: description: The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. type: string severity: description: The severity of the finding. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string summary: description: The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string timeUpdated: description: 'The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeValidUntil: description: The time until which the change in severity(deferred/modified) of this finding is valid. format: date-time type: string title: description: The short title for the finding. type: string AuditPolicyAnalyticCollection: description: Details of audit policy aggregation. properties: items: description: Array of audit policy aggregration data. items: $ref: '#/components/schemas/AuditPolicyAggregationItems' type: array required: - items type: object SecurityPolicyDeployment: description: 'The resource represents the state of the deployment of a security policy on a target. ' properties: compartmentId: description: The OCID of the compartment containing the security policy deployment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy deployment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy deployment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy deployment. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy deployment in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy deployment. enum: - CREATING - UPDATING - DEPLOYED - PENDING_DEPLOYMENT - NEEDS_ATTENTION - FAILED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyDeploymentLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target/target group where the security policy is deployed. maxLength: 255 minLength: 1 type: string targetType: description: Indicates whether the security policy deployment is for a target database or a target database group. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string timeCreated: description: The time that the security policy deployment was created, in the format defined by RFC3339. format: date-time type: string timeDeployed: description: The last date and time the security policy was deployed, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the security policy deployment was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - targetId - securityPolicyId - timeCreated - lifecycleState type: object ChangeUnifiedAuditPolicyCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the unified audit policy. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object TargetDatabaseGroupSummary: description: Summary of the target database group used in list operations. Contains essential information without matching criteria. properties: compartmentId: description: The OCID for the compartment containing the target database group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the target database group. maxLength: 400 minLength: 1 type: string displayName: description: The name of the target database group. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the specified target database group. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details for the lifecycle status of the target database group. maxLength: 1000 minLength: 1 type: string lifecycleState: description: The lifecycle status of the target database group. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/TargetDatabaseGroupLifecycleState' membershipCount: description: The number of target databases in the specified target database group. minimum: 0 type: integer membershipUpdateTime: description: Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed. format: date-time type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Time when the target database group was created. format: date-time type: string timeUpdated: description: Time when the target database group was last updated. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - timeUpdated - membershipUpdateTime - membershipCount type: object FirewallConfig: description: 'The SQL Firewall related configurations. ' properties: excludeJob: description: Specifies whether the firewall should include or exclude the database internal job activities. enum: - EXCLUDED - INCLUDED type: string status: description: Specifies if the firewall is enabled or disabled. enum: - ENABLED - DISABLED type: string timeStatusUpdated: description: The date and time the firewall configuration was last updated, in the format defined by RFC3339. format: date-time type: string violationLogAutoPurge: description: "Specifies whether Data Safe should automatically purge the violation logs \nfrom the database after collecting the violation logs and persisting on Data Safe.\n" enum: - ENABLED - DISABLED type: string required: - status - violationLogAutoPurge type: object SqlFirewallViolationsCollection: description: Collection of SQL violation summary. properties: items: description: Array of SQL violation summary. items: $ref: '#/components/schemas/SqlFirewallViolationSummary' type: array required: - items type: object CreateSensitiveColumnDetails: description: Details to create a new sensitive column in a sensitive data model. properties: appDefinedChildColumnKeys: description: 'Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array appName: description: 'The name of the application associated with the sensitive column. It''s useful when the application name is different from the schema name. Otherwise, it can be ignored. If this attribute is not provided, it''s automatically populated with the value provided for the schemaName attribute. ' maxLength: 128 minLength: 1 type: string x-default-description: The provided schema name. columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string x-default-description: VARCHAR2 dbDefinedChildColumnKeys: description: 'Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: default: TABLE description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string parentColumnKeys: description: 'Unique keys identifying the columns that are parents of the sensitive column. At present, it accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array relationType: default: NONE description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type to be associated with the sensitive column. maxLength: 255 minLength: 1 type: string status: default: VALID description: 'The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive. ' enum: - VALID - INVALID type: string required: - schemaName - objectName - columnName type: object SecurityAssessmentTemplateDetails: description: The details required to set the template for the assessment. properties: templateAssessmentId: description: The OCID of the template type security assessment containing the check details. maxLength: 255 minLength: 1 type: string type: object DataSafePrivateEndpoint: description: A Data Safe private endpoint that allows Data Safe to connect to databases in a customer's virtual cloud network (VCN). properties: compartmentId: description: The OCID of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the private endpoint. type: string displayName: description: The display name of the private endpoint. type: string endpointFqdn: description: The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Data Safe private endpoint. type: string lifecycleState: description: The current state of the private endpoint. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NA type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' nsgIds: description: 'The OCIDs of the network security groups that the private endpoint belongs to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateEndpointId: description: The OCID of the underlying private endpoint. type: string privateEndpointIp: description: 'The private IP address of the private endpoint. ' maxLength: 46 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' maxProperties: 25 type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' maxProperties: 10 type: object subnetId: description: The OCID of the subnet. type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string vcnId: description: The OCID of the VCN. type: string required: - id - displayName - compartmentId - vcnId - subnetId - privateEndpointId type: object FindingAnalyticsCollection: description: The collection of the summary objects of the analytics data of findings or top findings. properties: items: description: The array of the summary objects of the analytics data of findings or top findings. items: $ref: '#/components/schemas/FindingAnalyticsSummary' type: array required: - items type: object MaskingPolicyColumnsInfo: description: maskingPolicyColumnsInfo object has details of column group with schema details. properties: objectName: description: The name of the object (table or editioning view) that contains the database column(s). maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the masking policy. enum: - TABLE type: string referentialColumnGroup: description: 'Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. ' items: maxLength: 128 minLength: 1 type: string maxItems: 32 minItems: 1 type: array schemaName: description: The name of the schema that contains the database column(s). maxLength: 128 minLength: 1 type: string required: - schemaName - objectType - objectName - referentialColumnGroup type: object CreateUserAssessmentDetails: description: The details required to save a user assessment. properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the user assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the user assessment. maxLength: 255 minLength: 1 type: string x-default-description: If a value is not provided, this field is automatically set to a value in the format UA . freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object schedule: description: "To schedule the assessment for saving periodically, specify the schedule in this attribute.\nCreate or schedule one assessment per compartment. If not defined, the assessment runs immediately.\n Format -\n ;\n\n Allowed version strings - \"v1\"\n v1's version specific schedule - \n Each of the above fields potentially introduce constraints. A workrequest is created only\n when clock time satisfies all the constraints. Constraints introduced:\n 1. seconds = (So, the allowed range for is [0, 59])\n 2. minutes = (So, the allowed range for is [0, 59])\n 3. hours = (So, the allowed range for is [0, 23])\n can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday))\n 4. No constraint introduced when it is '*'. When not, day of week must equal the given value\n can be either '*' (without quotes or a number between 1 and 28)\n 5. No constraint introduced when it is '*'. When not, day of month must equal the given value\n" example: '1. "0 30 13 * *" - This indicates to run a user assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a user assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a user assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string targetId: description: The OCID of the target database or target database group on which user assessment is to be run. maxLength: 255 minLength: 1 type: string targetType: default: TARGET_DATABASE description: The type of user assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/UserAssessmentTargetType' required: - compartmentId - targetId type: object GenerateMaskingPolicyForDownloadDetails: description: Details to generate a downloadable masking policy. properties: policyFormat: default: XML description: The format of the masking policy file. enum: - XML type: string x-obmcs-top-level-enum: '#/definitions/PolicyFormat' type: object ReportDefinition: description: Description of report definition. properties: category: description: Specifies the name of the category that this report belongs to. enum: - CUSTOM_REPORTS - SUMMARY - ACTIVITY_AUDITING - FIREWALL_VIOLATIONS - ALLOWED_SQL type: string columnFilters: description: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden. items: $ref: '#/components/schemas/columnFilter' type: array columnInfo: description: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user). items: $ref: '#/components/schemas/column' type: array columnSortings: description: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc. items: $ref: '#/components/schemas/columnSorting' type: array compartmentId: description: The OCID of the compartment containing the report definition. maxLength: 255 minLength: 1 type: string complianceStandards: description: The list of the data protection regulations/standards used in the report that will help demonstrate compliance. items: maxLength: 255 minLength: 1 type: string maxItems: 30 type: array dataSource: description: Specifies the name of a resource that provides data for the report. For example alerts, events. enum: - EVENTS - ALERTS - VIOLATIONS - ALLOWED_SQL type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionDataSource' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the report definition. maxLength: 400 minLength: 1 type: string displayName: description: Name of the report definition. maxLength: 255 minLength: 1 type: string displayOrder: description: Specifies how the report definitions are ordered in the display. format: int32 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the report definition. maxLength: 255 minLength: 1 type: string isSchedulePaginationEnabled: default: false description: 'Indicates if the reports being generated should be paginated. If set to true, multiple reports can be generated and the details of next and previous report are present in Report. Values can either be ''true'' or ''false''. ' type: boolean isSeeded: description: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'. type: boolean lifecycleDetails: description: Details about the current state of the report definition in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the report. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionLifecycleState' parentId: description: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID. maxLength: 255 minLength: 1 type: string recordTimeSpan: description: 'The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1) ' example: '1. "12H" - This indicates to generate a report for records in last 12 hours from scheduled time. 2. "7D" - This indicates to generate a report for records in last 7 days from scheduled time. 3. "2M" - This indicates to generate a report for records in last 2 months from scheduled time. ' maxLength: 4 minLength: 2 type: string schedule: description: 'The schedule to generate the report periodically in the specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ''*''. When not, day of week must equal the given value 5. can be either ''*'' (without quotes or a number between 1 and 28) No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to generate a report at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to generate a report at 13:30:00 every Tuesday 3. "0 30 13 * 3" - This indicates to generate a report at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string scheduledReportCompartmentId: description: 'The OCID of the compartment in which the scheduled resource will be created. ' maxLength: 255 minLength: 1 type: string scheduledReportMimeType: description: Specifies the format of the report ( either .xls or .pdf or .json) enum: - PDF - XLS - JSON type: string scheduledReportName: description: The name of the report to be scheduled. maxLength: 255 minLength: 1 type: string scheduledReportRowLimit: description: Specifies the limit on the number of rows in the report. format: int32 type: integer scimFilter: description: Additional SCIM filters used to define the report. maxLength: 4000 minLength: 1 type: string summary: description: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user). items: $ref: '#/components/schemas/summary' type: array systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Specifies the date and time the report definition was created. format: date-time type: string timeUpdated: description: The date and time the report definition was updated. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState type: object PeerTargetDatabaseCollection: description: Summary of peer target databases of a primary target database. properties: compartmentId: description: The OCID of the compartment that contains the primary target database. example: ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnxernheayom3pljsfppca maxLength: 100 minLength: 1 type: string items: description: The list of peer target databases associated to the primary target database. items: $ref: '#/components/schemas/PeerTargetDatabaseSummary' maxItems: 30 type: array targetDatabaseId: description: The OCID of the Data Safe target database. maxLength: 255 minLength: 1 type: string required: - targetDatabaseId - compartmentId type: object SqlFirewallViolationAggregationDimensions: description: The details of the aggregation dimensions used for summarizing SQL violations. properties: clientIp: description: The IP address of the host from which the session was spawned. items: maxLength: 255 minLength: 1 type: string type: array clientOsUserName: description: The name of the operating system user for the database session. items: maxLength: 1024 minLength: 1 type: string type: array clientProgram: description: The application from which the SQL violation was generated. Examples SQL Plus or SQL Developer. items: maxLength: 512 minLength: 1 type: string type: array dbUserName: description: The name of the database user. items: maxLength: 1024 minLength: 1 type: string type: array operation: description: The name of the action executed by the user on the target database, for example, ALTER, CREATE, DROP. items: maxLength: 1024 minLength: 1 type: string type: array operationTime: description: The time of the SQL violation occurrence in the target database. items: format: date-time type: string type: array sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' items: enum: - USER_ISSUED_SQL - ALL_SQL type: string type: array targetId: description: The OCID of the target database. items: maxLength: 255 minLength: 1 type: string type: array targetName: description: The name of the target database. items: maxLength: 255 minLength: 1 type: string type: array violationAction: description: The action taken for this SQL violation. items: maxLength: 255 minLength: 1 type: string type: array violationCause: description: Indicates whether SQL or context violation. items: maxLength: 30 minLength: 1 type: string type: array type: object CompatibleFormatsForSensitiveTypes: description: The list of compatible masking formats grouped by generic sensitive types. properties: formatsForSensitiveType: description: An array of library masking formats compatible with the existing sensitive types. items: $ref: '#/components/schemas/FormatsForSensitiveType' type: array required: - formatsForSensitiveType type: object TargetAlertPolicyAssociation: description: The association of the target database to an alert policy. properties: compartmentId: description: The OCID of the compartment that contains the policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Describes the target-alert policy association. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target-alert policy association. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the target-alert policy association. example: ocid1.datasafetargetalertpolicyAssociation.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Indicates if the target-alert policy association is enabled or disabled by user. type: boolean lifecycleState: description: The current state of the target-alert policy association. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: CREATING type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyLifecycleState' policyId: description: The OCID of the alert policy. example: ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target or target database group on which alert policy is to be applied. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the target alert policy association. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP example: TARGET_DATABASE/TARGET_DATABASE_GROUP type: string timeCreated: description: Creation date and time of the alert policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the alert policy was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - targetType type: object ChangeSecurityPolicyCompartmentDetails: description: Details of the compartment the security policy will be moved to. properties: compartmentId: description: The OCID of the compartment where you want to move the security policy. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateTargetDatabaseDetails: description: The details of the database used for updating the target database in Data Safe. properties: connectionOption: $ref: '#/components/schemas/ConnectionOption' credentials: $ref: '#/components/schemas/Credentials' databaseDetails: $ref: '#/components/schemas/DatabaseDetails' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target database in Data Safe. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object tlsConfig: $ref: '#/components/schemas/TlsConfig' type: object ChangeSdmMaskingPolicyDifferenceCompartmentDetails: description: Details to change the compartment of a SDM masking policy difference. properties: compartmentId: description: The OCID of the compartment where the SDM masking policy difference should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object Alert: description: The details of a Data Safe Alert, that shows alerts generated by a Data Safe feature. properties: alertType: description: Type of the alert. Indicates the Data Safe feature triggering the alert. enum: - AUDITING - SECURITY_ASSESSMENT - USER_ASSESSMENT type: string x-obmcs-top-level-enum: '#/definitions/AlertType' comment: description: A comment for the alert. Entered by the user. maxLength: 400 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the alert. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the alert. maxLength: 400 type: string displayName: description: The display name of the alert. maxLength: 255 minLength: 1 type: string featureDetails: additionalProperties: additionalProperties: description: 'Value of the map as key-pair values. Example: `{"critical": "users"}` ' type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object description: "Map that contains maps of values.\n Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n" type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the alert. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the alert. enum: - UPDATING - SUCCEEDED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AlertLifecycleState' operation: description: The operation (event) that triggered alert. maxLength: 255 minLength: 1 type: string operationStatus: description: The result of the operation (event) that triggered alert. enum: - SUCCEEDED - FAILED type: string operationTime: description: Creation date and time of the operation that triggered alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string policyId: description: The OCID of the policy that triggered alert. maxLength: 255 minLength: 1 type: string resourceName: description: The resource endpoint that triggered the alert. maxLength: 255 minLength: 1 type: string severity: description: Severity level of the alert. enum: - CRITICAL - HIGH - MEDIUM - LOW - EVALUATE type: string x-obmcs-top-level-enum: '#/definitions/AlertSeverity' status: description: The status of the alert. enum: - OPEN - CLOSED type: string x-obmcs-top-level-enum: '#/definitions/AlertStatus' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetIds: description: Array of OCIDs of the target database which are associated with the alert. items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true targetNames: description: Array of names of the target database. items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: false timeCreated: description: Creation date and time of the alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the alert was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState type: object DiscoveryJobResultSummary: description: Summary of a discovery job result. properties: columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string discoveryJobId: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string discoveryType: description: 'The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified. ' type: string x-obmcs-enumref: '#/definitions/DiscoveryJobResult/discoveryType' estimatedDataValueCount: description: The estimated number of data values the column has in the associated database. format: int64 type: integer isResultApplied: default: false description: 'Indicates whether the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model. ' type: boolean key: description: The unique key that identifies the discovery result. maxLength: 255 minLength: 1 type: string objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string parentColumnKeys: description: Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. items: maxLength: 255 minLength: 1 type: string type: array plannedAction: description: 'Specifies how to process the discovery result. It''s set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn''t change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren''t reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results. ' type: string x-obmcs-enumref: '#/definitions/DiscoveryJobResult/plannedAction' relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sampleDataValues: description: 'Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. ' items: maxLength: 4000 minLength: 1 type: string type: array schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveColumnkey: description: The unique key that identifies the sensitive column represented by the discovery result. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the sensitive column. maxLength: 255 minLength: 1 type: string required: - key - discoveryType - schemaName - objectName - columnName - objectType - dataType - relationType - estimatedDataValueCount - plannedAction - isResultApplied - discoveryJobId type: object FormatSummary: description: Summary of a masking format. properties: description: description: The description of the masking format. maxLength: 400 minLength: 1 type: string id: description: The OCID of the masking format. maxLength: 255 minLength: 1 type: string name: description: The name of the masking format. maxLength: 512 minLength: 1 type: string required: - name type: object SqlFirewallAllowedSqlAnalyticsCollection: description: SQL Firewall allowed SQL analytics collection. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/SqlFirewallAllowedSqlAggregation' type: array required: - items type: object ChangeRegistrationPolicyCompartmentDetails: description: 'The details required to move a registration policy to a different compartment. This object contains the OCID of the compartment to which the registration policy should be moved. ' properties: compartmentId: description: The OCID of the compartment to which the registration policy should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId SqlFirewallPolicyDimensions: description: The dimensions available for SQL Firewall policy analytics. properties: enforcementScope: description: Specifies the SQL Firewall policy enforcement option. enum: - ENFORCE_CONTEXT - ENFORCE_SQL - ENFORCE_ALL type: string lifecycleState: description: The current state of the SQL Firewall policy. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallPolicyLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the SQL Firewall policy. maxLength: 255 minLength: 1 type: string violationAction: description: Specifies the mode in which the SQL Firewall policy is enabled. enum: - BLOCK - OBSERVE type: string type: object UnsetSecurityAssessmentBaselineDetails: description: The details required to unset the baseline of the assessment. properties: targetIds: description: The list of database target OCIDs for which the user intends to unset the baseline. items: maxLength: 255 minLength: 1 type: string maxItems: 1000 type: array type: object MaskingObjectCollection: description: A collection of masking object summary objects. properties: items: description: An array of masking object summary objects. items: $ref: '#/components/schemas/MaskingObjectSummary' type: array required: - items type: object TargetDatabaseGroup: description: The details of the target database group including matching criteria. Used for a single resource retrieval. properties: compartmentId: description: The OCID for the compartment containing the target database group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the target database group. maxLength: 400 minLength: 1 type: string displayName: description: The name of the target database group. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the specified target database group. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details for the lifecycle status of the target database group. maxLength: 1000 minLength: 1 type: string lifecycleState: description: The lifecycle status of the target database group. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/TargetDatabaseGroupLifecycleState' matchingCriteria: $ref: '#/components/schemas/MatchingCriteria' membershipCount: description: The number of target databases in the specified target database group. minimum: 0 type: integer membershipUpdateTime: description: Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed. format: date-time type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Time when the target database group was created. format: date-time type: string timeUpdated: description: Time when the target database group was last updated. format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState - matchingCriteria - membershipCount - membershipUpdateTime type: object ScheduleReportDetails: description: The details of the report schedule. properties: compartmentId: description: 'The OCID of the compartment in which the resource should be created. ' maxLength: 255 minLength: 1 type: string displayName: description: The name of the report to be scheduled maxLength: 255 minLength: 1 type: string isPaginationEnabled: default: false description: "Indicates if the reports being generated should be paginated. \nIf set to true, multiple reports can be generated and the details of next and previous report are present in Report.\nValues can either be 'true' or 'false'.\n" type: boolean mimeType: description: Specifies if the report will be in .xls or .pdf or .json format enum: - PDF - XLS - JSON type: string reportDetails: $ref: '#/components/schemas/ReportDetails' schedule: description: 'The schedule to generate the report periodically in the specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ''*''. When not, day of week must equal the given value 5. can be either ''*'' (without quotes or a number between 1 and 28) No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to generate a report at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to generate a report at 13:30:00 every Tuesday 3. "0 30 13 * 3" - This indicates to generate a report at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string required: - schedule - mimeType - compartmentId - reportDetails type: object AlertPolicyCollection: description: Collection of alert policy summary. properties: items: description: Array of alert policy summary items: $ref: '#/components/schemas/AlertPolicySummary' type: array required: - items type: object CreateUnifiedAuditPolicyDetails: description: The details required to create a new unified audit policy. properties: compartmentId: description: The OCID of the compartment in which to create the unified audit policy. maxLength: 255 minLength: 1 type: string conditions: description: Lists the audit policy provisioning conditions. items: $ref: '#/components/schemas/PolicyCondition' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy in Data Safe. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the unified audit policy in Data Safe. The name is modifiable and does not need to be unique. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format UnifiedAuditPolicy freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object securityPolicyId: description: The OCID of the security policy corresponding to the unified audit policy. maxLength: 255 minLength: 1 type: string status: description: Indicates whether the unified audit policy has been enabled or disabled. type: string x-obmcs-enumref: '#/definitions/UnifiedAuditPolicy/status' unifiedAuditPolicyDefinitionId: description: The OCID of the associated unified audit policy definition. maxLength: 255 minLength: 1 type: string required: - unifiedAuditPolicyDefinitionId - securityPolicyId - compartmentId - status - conditions type: object ChangeSqlFirewallPolicyCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the SQL Firewall policy. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object SecurityAssessmentComparisonPerTarget: description: 'The results of the comparison between two security assessment resources. ' properties: auditing: description: A comparison between findings belonging to Auditing category. items: $ref: '#/components/schemas/Diffs' type: array authorizationControl: description: A comparison between findings belonging to Authorization Control category. items: $ref: '#/components/schemas/Diffs' type: array baselineTargetId: description: The OCID of the target that is used as a baseline in this comparison. type: string currentTargetId: description: The OCID of the target to be compared against the baseline target. type: string dataEncryption: description: Comparison between findings belonging to Data Encryption category. items: $ref: '#/components/schemas/Diffs' type: array dbConfiguration: description: Comparison between findings belonging to Database Configuration category. items: $ref: '#/components/schemas/Diffs' type: array fineGrainedAccessControl: description: Comparison between findings belonging to Fine-Grained Access Control category. items: $ref: '#/components/schemas/Diffs' type: array privilegesAndRoles: description: Comparison between findings belonging to Privileges and Roles category. items: $ref: '#/components/schemas/Diffs' type: array userAccounts: description: Comparison between findings belonging to User Accounts category. items: $ref: '#/components/schemas/Diffs' type: array type: object CompareSecurityAssessmentDetails: description: Details specifying the security assessment used for comparison. properties: comparisonSecurityAssessmentId: description: 'The OCID of the security assessment. In this case a security assessment can be another security assessment, a latest assessment or a baseline. ' maxLength: 255 minLength: 1 type: string required: - comparisonSecurityAssessmentId type: object SensitiveObjectSummary: description: Summary of a sensitive object present in a sensitive data model. properties: objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string required: - schemaName - objectName - objectType type: object ChangeSensitiveTypesExportCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the sensitive types export. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object AuditSpecification: description: 'Represents an audit policy relevant for the target database.The audit policy could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on relevant audit policies for the target database, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). ' properties: auditPolicyCategory: description: The category to which the audit policy belongs. enum: - BASIC_ACTIVITY - ADMIN_USER_ACTIVITY - USER_ACTIVITY - ORACLE_PREDEFINED - COMPLIANCE_STANDARD - CUSTOM - SQL_FIREWALL_AUDITING type: string x-obmcs-top-level-enum: '#/definitions/AuditPolicyCategory' auditPolicyName: description: 'Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. ' maxLength: 512 minLength: 1 type: string databasePolicyNames: description: Indicates the names of corresponding database policy ( or policies) in the target database. items: maxLength: 512 minLength: 1 type: string type: array enableStatus: description: Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled. enum: - ENABLED - DISABLED - PARTIALLY_ENABLED type: string enabledEntities: description: Indicates on whom the audit policy is enabled. enum: - ALL_USERS - INCLUDE_USERS - INCLUDE_ROLES - EXCLUDE_USERS - INCLUDE_USERS_ROLES - DISABLED type: string isCreated: description: Indicates whether the policy is already created on the target database. type: boolean isEnabledForAllUsers: description: Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions. type: boolean isSeededInDataSafe: description: Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe. type: boolean isSeededInTarget: description: Indicates whether the audit policy is one of the predefined policies provided by Oracle Database. type: boolean isViewOnly: description: Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target. type: boolean partiallyEnabledMsg: description: Provides information about the policy that has been only partially enabled. maxLength: 4000 type: string x-default-description: 'null' required: - auditPolicyName - databasePolicyNames - auditPolicyCategory - enableStatus - isEnabledForAllUsers - isViewOnly - isSeededInTarget - isSeededInDataSafe - isCreated - enabledEntities type: object MaskingPolicyHealthReport: description: The masking policy health report. properties: compartmentId: description: The OCID of the compartment that contains the health report. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking health report. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the health report. maxLength: 255 minLength: 1 type: string errorCount: description: The count of errors in the masking health report. format: int64 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the health report. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the health report. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string maskingPolicyId: description: The OCID of the masking policy. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database for which this report was created. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: "The date and time the report was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) \n" format: date-time type: string warningCount: description: The count of warnings in the masking health report. format: int64 type: integer required: - id - maskingPolicyId - targetId - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags type: object DatabaseDetails: description: 'Details of the database for the registration in Data Safe. ' discriminator: propertyName: databaseType properties: databaseType: description: The database type. enum: - DATABASE_CLOUD_SERVICE - AUTONOMOUS_DATABASE - INSTALLED_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseType' infrastructureType: description: The infrastructure type the database is running on. enum: - ORACLE_CLOUD - CLOUD_AT_CUSTOMER - ON_PREMISES - NON_ORACLE_CLOUD type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureType' required: - infrastructureType - databaseType type: object CollectedAuditVolumeSummary: description: The volume data point for audit data collected by datasafe. properties: archivedVolume: description: The audit data volume collected by Data Safe and is available in archive storage. format: int64 type: integer auditProfileId: description: The OCID of the audit profile resource. maxLength: 255 minLength: 1 type: string monthInConsideration: description: 'Represents the month under consideration in which the aggregated audit data volume collected by Data Safe is displayed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. ' format: date-time type: string onlineVolume: description: The audit data volume collected by Data Safe and is available online in repository. format: int64 type: integer required: - auditProfileId - monthInConsideration - onlineVolume - archivedVolume type: object AuditTrailAnalyticCollection: description: 'Details of audit trail analytic summary. ' properties: items: description: Array of audit trail aggregration data. items: $ref: '#/components/schemas/AuditTrailAggregationItems' type: array required: - items type: object SecurityPolicyReport: description: 'The resource represents the security policy report ' properties: compartmentId: description: The OCID of the compartment that contains the security policy report. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy report. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy report. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy report. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy report. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy report. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: CREATING type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyReportLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the security policy report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the security policy report was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - timeCreated - targetId - displayName - lifecycleState type: object AuditPolicy: description: 'The resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on available audit policies, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). ' properties: auditConditions: description: Lists the audit policy provisioning conditions for the target database. items: $ref: '#/components/schemas/AuditConditions' type: array auditSpecifications: description: 'Represents all available audit policy specifications relevant for the target database. For more details on available audit polcies, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). ' items: $ref: '#/components/schemas/AuditSpecification' type: array compartmentId: description: The OCID of the compartment containing the audit policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit policy. maxLength: 255 minLength: 1 type: string isDataSafeServiceAccountExcluded: description: Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies. type: boolean lifecycleDetails: description: Details about the current state of the audit policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit policy. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/AuditPolicyLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target for which the audit policy is created. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the the audit policy was created, in the format defined by RFC3339. format: date-time type: string timeLastProvisioned: description: Indicates the last provisioning time of audit policies on the target, in the format defined by RFC3339. format: date-time type: string timeLastRetrieved: description: The time when the audit policies was last retrieved from this target, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the audit policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState - targetId - isDataSafeServiceAccountExcluded type: object PolicyConnectionOption: description: Types of connection supported by Data Safe. properties: connectionType: description: 'The connection type used to connect to the database. Allowed values: - PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. - ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe. ' enum: - PRIVATE_ENDPOINT - ONPREM_CONNECTOR type: string identifiers: description: "List of OCIDs required to establish the connection. \n- For `PRIVATE_ENDPOINT`, provide the OCID(s) of Data Safe private endpoint(s). \n- For `ONPREM_CONNECTOR`, provide the OCID(s) of on-premises connector(s).\n" items: maxLength: 255 minLength: 1 type: string maxItems: 20 minItems: 1 type: array required: - connectionType - identifiers type: object UpdateSdmMaskingPolicyDifferenceDetails: description: Details to update a sdm masking policy difference. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The display name of the sdm masking policy difference. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object SqlCollectionSummary: description: "The resource represents SQL collection for a specific database user in a target. \nSqlCollection encapsulates the SQL commands issued in the user’s database sessions, and its execution context.\n" properties: compartmentId: description: The OCID of the compartment containing the SQL collection. maxLength: 100 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL collection. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL collection. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL collection. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the SQL collection in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the SQL collection. enum: - CREATING - UPDATING - COLLECTING - COMPLETED - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlCollectionLifecycleState' sqlLevel: description: 'Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string status: description: Specifies if the status of the SqlCollection. Enabled indicates that the collecting is in progress. enum: - ENABLED - DISABLED type: string targetId: description: The OCID of the target corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string timeCreated: description: The time that the SQL collection was created, in the format defined by RFC3339. format: date-time type: string timeLastStarted: description: The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339. format: date-time type: string timeLastStopped: description: The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the SQL collection was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState - targetId - dbUserName - status type: object AlertsAggregationDimension: description: Details of aggregation dimension summarizing alerts. properties: groupBy: additionalProperties: type: string description: GroupBy value used in aggregation. type: object required: - groupBy type: object ChangeTargetAlertPolicyAssociationCompartmentDetails: description: The details used to change the compartment of a target-alert policy association. properties: compartmentId: description: The OCID of the compartment to move the target-alert policy association to. maxLength: 100 minLength: 1 type: string required: - compartmentId TargetOverrideSummary: description: Summary of the target database-specific profiles that override the audit profile of the target database group. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean offlineMonths: description: 'Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer (up to 168 months) in the offline archive, please contact the Oracle Support. ' format: int32 maximum: 168 minimum: 0 type: integer offlineMonthsSource: description: The name or the OCID of the resource from which the offline month retention setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string onlineMonths: description: 'Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months ' format: int32 maximum: 12 minimum: 1 type: integer onlineMonthsSource: description: The name or the OCID of the resource from which the online month retention setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string paidUsageSource: description: The name or the OCID of the resource from which the paid usage setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseId: description: The OCID of the target database that overrides from the audit profile of the target database group. maxLength: 255 minLength: 1 type: string required: - targetDatabaseId - isPaidUsageEnabled - onlineMonths - offlineMonths type: object TargetOverrideCollection: description: Collection of target override summary. properties: items: description: Array of target database override summary. items: $ref: '#/components/schemas/TargetOverrideSummary' type: array targetsConformingCount: description: Number of target databases within the target database group that conform with the audit profile of the target database group. format: int32 type: integer targetsCount: description: Number of target databases within the target database group. format: int32 type: integer targetsOverridingCount: description: Number of target databases within the target database group that override the audit profile of the target database group. format: int32 type: integer targetsOverridingOfflineMonthsCount: description: Number of target databases within the group that override the offline retention setting of the audit profile for the target database group. format: int32 type: integer targetsOverridingOnlineMonthsCount: description: Number of target databases within the group that override the online retention setting of the audit profile for the target database group. format: int32 type: integer targetsOverridingPaidUsageCount: description: Number of target databases within the group that override the paid usage setting of the audit profile for the target database group. format: int32 type: integer required: - targetsCount - targetsOverridingCount - targetsConformingCount - targetsOverridingPaidUsageCount - targetsOverridingOnlineMonthsCount - targetsOverridingOfflineMonthsCount - items type: object RegistrationPolicyCollection: description: 'A collection of registration policy summaries. This object contains an array of registration policy summary items. ' properties: items: description: An array of registration policy summary items. items: $ref: '#/components/schemas/RegistrationPolicySummary' type: array required: - items type: object AuditPolicyAggregationItems: description: The details of the audit profile aggregation items. properties: count: description: The total count of the aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/AuditPolicyDimensions' type: object CreateMaskingPolicyDetails: description: "Details to create a new masking policy. Use either a sensitive data model or a reference \ntarget database to create your masking policy.\n\nTo use a sensitive data model as the source of masking columns, set the columnSource\nattribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After \ncreating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically\nadd all the columns from the associated sensitive data model. In this case, the target \ndatabase associated with the sensitive data model is used for column and masking format validations.\n\nYou can also create a masking policy without using a sensitive data model. In this case, \nyou need to associate your masking policy with a target database by setting the columnSource \nattribute to TARGET and providing the targetId attribute. The specified target database is \nused for column and masking format validations.\n\nAfter creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns \noperation to manually add columns to the policy. You need to add the parent columns only, \nand it automatically adds the child columns (in referential relationship with the parent \ncolumns) from the associated sensitive data model or target database.\n" properties: columnSource: $ref: '#/components/schemas/CreateColumnSourceDetails' compartmentId: description: The OCID of the compartment where the masking policy should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking policy. maxLength: 400 minLength: 1 type: string x-default-description: The description will be set to null by default. displayName: description: The display name of the masking policy. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: It will be set to a value in the format MaskingPolicy_ freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isDropTempTablesEnabled: default: true description: "Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default.\nSet this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive \ndata values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want \nto preserve this information to track how masking changed your data. Note that doing so compromises security. These tables \nmust be dropped before the database is available for unprivileged users. \n" type: boolean isRedoLoggingEnabled: default: false description: "Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to\nenable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked \ndata from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking,\nyou could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. \n" type: boolean isRefreshStatsEnabled: default: true description: 'Indicates if statistics gathering is enabled. It''s enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes. ' type: boolean parallelDegree: default: DEFAULT description: 'Specifies options to enable parallel execution when running data masking. Allowed values are ''NONE'' (no parallelism), ''DEFAULT'' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. ' type: string postMaskingScript: description: 'A post-masking script, which can contain SQL and PL/SQL statements. It''s executed after the core masking script generated using the masking policy. It''s usually used to perform additional transformation or cleanup work after masking. ' type: string x-default-description: The postMaskingScript will be set to null by default. preMaskingScript: description: "A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before \nthe core masking script generated using the masking policy. It's usually used to perform\nany preparation or prerequisite work before masking data.\n" type: string x-default-description: The preMaskingScript will be set to null by default. recompile: default: NONE description: "Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), \n'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree\nattribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.\n" type: string x-obmcs-enumref: '#/definitions/MaskingPolicy/recompile' required: - compartmentId - columnSource type: object SchemaSummary: description: The details of a schema fetched from the database. properties: isOracleMaintained: description: Indicates if the schema is oracle supplied. type: boolean schemaName: description: Name of the schema. maxLength: 128 minLength: 1 type: string required: - schemaName - isOracleMaintained type: object ChangeSecurityPolicyConfigCompartmentDetails: description: The details of the compartment to move the security policy configuration to. properties: compartmentId: description: The OCID of the compartment where you want to move the security policy configuration. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object TemplateAssociationAnalyticsDimensions: description: The scope of template association analytics data. properties: targetDatabaseGroupId: description: "The OCID of the target database group that the group assessment is created for. \nThis field will be in the response if the template was applied on a target group.\n" maxLength: 255 minLength: 1 type: string targetId: description: 'The OCID of the target database. If the template was applied on a target group, this field will be the OCID of the target members of the target group. If the template was applied on an individual target, this field will contain that targetId. ' maxLength: 255 minLength: 1 type: string templateAssessmentId: description: The OCID of the security assessment of type TEMPLATE. maxLength: 255 minLength: 1 type: string templateBaselineAssessmentId: description: The OCID of the security assessment of type TEMPLATE_BASELINE. maxLength: 255 minLength: 1 type: string type: object AlertPolicy: description: 'An Alert Policy is a set of alerting rules evaluated against a target. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True. ' properties: alertPolicyType: description: Indicates the Data Safe feature to which the alert policy belongs. enum: - AUDITING - SECURITY_ASSESSMENT - USER_ASSESSMENT type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyType' compartmentId: description: The OCID of the compartment that contains the alert policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the alert policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the alert policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the alert policy. maxLength: 255 minLength: 1 type: string isUserDefined: description: Indicates if the alert policy is user-defined (true) or pre-defined (false). type: boolean lifecycleState: description: The current state of the alert. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyLifecycleState' severity: description: Severity level of the alert raised by this policy. enum: - CRITICAL - HIGH - MEDIUM - LOW - EVALUATE type: string x-obmcs-top-level-enum: '#/definitions/AlertSeverity' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation date and time of the alert policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the alert policy was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState type: object CreateAttributeSetDetails: description: The details for an attribute set. properties: attributeSetType: description: The type of attribute set. type: string x-obmcs-enumref: '#/definitions/AttributeSet/attributeSetType' attributeSetValues: description: The list of values in an attribute set items: maxLength: 256 minLength: 1 type: string maxItems: 1000 type: array compartmentId: description: The OCID of the compartment that contains the attribute set. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the attribute set. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the attribute set. The name is unique and changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object required: - displayName - compartmentId - attributeSetType - attributeSetValues type: object UpdateSensitiveDataModelDetails: description: 'Details to update a sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery. ' properties: appSuiteName: description: The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications. type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive data model. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive data model. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isAppDefinedRelationDiscoveryEnabled: description: 'Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It''s disabled by default and should be used only if there is a need to identify application-level relationships. ' type: boolean isSampleDataCollectionEnabled: description: 'Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it''s disabled by default and should be used only if it''s acceptable to store sample data in Data Safe''s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. ' type: boolean schemasForDiscovery: description: The schemas to be used for future data discovery jobs. items: maxLength: 128 minLength: 1 type: string type: array sensitiveTypeGroupIdsForDiscovery: description: 'The OCIDs of the sensitive type groups to be used by data discovery jobs. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array sensitiveTypeIdsForDiscovery: description: 'The OCIDs of the sensitive types to be used for future data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery. ' items: maxLength: 255 minLength: 1 type: string type: array tablesForDiscovery: description: "The data discovery jobs will scan the tables specified here, including both schemas and tables.\nFor instance, the input could be in the format: [{schemaName: \"HR\", tableName: [\"T1\", \"T2\"]}, {schemaName: \n\"OE\", tableName : [\"T3\", \"T4\"]}].\n" items: $ref: '#/components/schemas/TablesForDiscovery' maxItems: 1000 type: array targetId: description: 'The OCID of the reference target database to be associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database. Note that updating the targetId attribute does not perform data discovery automatically. ' maxLength: 255 minLength: 1 type: string type: object SensitiveTypesExport: description: The resource represents sensitive types to be exported in Data Safe. properties: compartmentId: description: The OCID of the compartment that contains the sensitive types export. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive types export. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive types export. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive types export. maxLength: 255 minLength: 1 type: string isIncludeAllSensitiveTypes: description: 'Indicates if all the existing user-defined sensitive types are used for export. If it''s set to true, the sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are exported. ' type: boolean lifecycleState: description: The current state of the sensitive types export. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypesExportLifecycleState' sensitiveTypeIdsForExport: description: 'The OCIDs of the sensitive types used to create sensitive types export. ' items: maxLength: 255 minLength: 1 type: string maxItems: 1000 type: array systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the sensitive types export was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive types export was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - isIncludeAllSensitiveTypes type: object UpdateAuditArchiveRetrievalDetails: description: Details to update the audit archive retrieval. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the archive retrieval. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the archive retrieval. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object SensitiveTypeGroupSummary: description: Summary of the sensitive type group. properties: compartmentId: description: The OCID of the compartment that contains sensitive type group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type group. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type group. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive type group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the sensitive type group. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeGroupLifecycleState' sensitiveTypeCount: description: The number of sensitive types in the specified sensitive type group. minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the sensitive type group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive type group was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState - sensitiveTypeCount type: object CreateOnPremConnectorDetails: description: The details used to create a new on-premises connector. properties: compartmentId: description: The OCID of the compartment where you want to create the on-premises connector. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the on-premises connector. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the on-premises connector. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format OC freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object required: - compartmentId type: object FormatsForDataType: description: A list of basic masking formats compatible with a supported data type. properties: dataType: description: "The data type category, which can be one of the following -\n Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2\n Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE\n Date - Includes DATE and TIMESTAMP\n LOB - Includes BLOB, CLOB, and NCLOB\n All - Includes all the supported data types \n" type: string maskingFormats: description: An array of the basic masking formats compatible with the data type category. items: $ref: '#/components/schemas/FormatSummary' type: array required: - dataType type: object GenerateSecurityAssessmentReportDetails: description: The details used to generate a new security assessment report. properties: format: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string isSingleReport: default: false description: 'Optional flag controlling the output format of a target group report: - true: Generate a single consolidated report file for the entire target group. - false: Generate a ZIP archive containing one file per target in the group. Important: - This flag is only applicable when the security assessment OCID refers to a target group assessment (targetType TARGET_DATABASE_GROUP). - If `isSingleReport` is set to true for an individual target (targetType TARGET_DATABASE), the request will return an error. - If `isSingleReport` is null or false for an individual target, the value is ignored and the selected output format for the assessment type is generated. ' type: boolean required: - format type: object UserAggregation: description: 'The user aggregation provides information about the overall security state of database users. For example, it states how many users have the DBA role and how many users are in the critical category. ' properties: items: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: additionalProperties: type: object type: object type: array required: - items type: object AvailableAuditVolumeSummary: description: 'Represents the audit data volume collected by Data Safe from the target database for the specified audit profile. ' properties: auditProfileId: description: The OCID of the audit profile resource. maxLength: 255 minLength: 1 type: string auditTrailId: description: The OCID of the audit trail. maxLength: 255 minLength: 1 type: string databaseUniqueName: description: Unique name of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string monthInConsideration: description: 'Represents the month under consideration for which aggregated audit data volume available at the target is computed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. ' format: date-time type: string trailLocation: description: Audit trail location on the target database from where the audit data is being collected by Data Safe. maxLength: 4000 minLength: 1 type: string volume: description: 'Represents the aggregated audit data volume available in the audit trails on the target database which is yet to be collected by Data Safe for the specified month. ' format: int64 type: integer required: - auditProfileId - monthInConsideration - trailLocation - volume type: object TemplateAnalyticsDimensions: description: The scope of analytics data. properties: isCompared: description: 'Indicates whether or not the comparison between the latest assessment and the template baseline assessment is done. If the value is false, it means the comparison is not done yet. ' type: boolean isCompliant: description: 'Indicates whether or not the latest assessment is compliant with the template baseline assessment. If the value is false, it means there is drift in the comparison report and the totalChecksFailed field will have a non-zero value. ' type: boolean isGroup: description: "Indicates whether or not the template security assessment is applied to a target group. \nIf the value is false, it means the template security assessment is applied to a individual target.\n" type: boolean targetDatabaseGroupId: description: "The OCID of the target database group that the group assessment is created for. \nThis field will be in the response if the template was applied on a target group.\n" maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database. This field will be in the response if the template was applied on an individual target. maxLength: 255 minLength: 1 type: string templateAssessmentId: description: The OCID of the security assessment of type TEMPLATE. maxLength: 255 minLength: 1 type: string templateBaselineAssessmentId: description: The OCID of the security assessment of type TEMPLATE_BASELINE. maxLength: 255 minLength: 1 type: string timeLastCompared: description: The date and time when the comparison was made upon the template baseline. Conforms to the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string totalChecks: description: The number of checks inside the template assessment. type: integer totalChecksFailed: description: 'Indicates how many checks in the template have drifts in the comparison report. This field is only present if isCompliant is false. ' type: integer totalNonCompliantTargets: description: 'The number of the target(s) that have drifts in the comparison report. This field is only present if isCompared is true. ' type: integer totalTargets: description: 'The number of the target(s) inside the target group for which the template baseline assessment was created for. If the isGroup field is false, the value will be 1, representing the single target. ' type: integer type: object TemplateAnalyticsCollection: description: The collection of template analytics summary. properties: items: description: The array of template analytics summary. items: $ref: '#/components/schemas/TemplateAnalyticsSummary' maxItems: 1000 type: array required: - items type: object CreateSecurityAssessmentDetails: description: The details used to save a security assessment. properties: baseSecurityAssessmentId: description: "The OCID of the security assessment. The assessment should be of type SAVED. \nIt will be required while creating the template baseline assessment for individual targets to fetch the detailed information from an existing security assessment.\n" maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the security assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the security assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security assessment. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format SA if not provided. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object schedule: description: 'To schedule the assessment for running periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a security assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a security assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a security assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string targetId: description: The OCID of the target database or target database group on which security assessment is to be run. maxLength: 255 minLength: 1 type: string targetType: default: TARGET_DATABASE description: The type of security assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentTargetType' templateAssessmentId: description: The OCID of the template assessment. It will be required while creating the template baseline assessment. maxLength: 255 minLength: 1 type: string type: description: The type of the security assessment enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT - TEMPLATE - TEMPLATE_BASELINE type: string required: - compartmentId type: object TargetAlertPolicyUnassociatedSummary: description: Summary of the target databases that differ from the association of the target database group. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Indicates if the target-alert policy association is enabled or disabled by user. type: boolean notAppliedReason: description: Details on why policy is not applied on target. maxLength: 400 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseId: description: The OCID of the target database that differs from the alert policy association of the target database group. maxLength: 255 minLength: 1 type: string required: - targetDatabaseId - isEnabled type: object ChangeLibraryMaskingFormatCompartmentDetails: description: Details to change the compartment of a library masking format. properties: compartmentId: description: The OCID of the compartment where the library masking format should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object MaskingPolicyReferentialRelationCollection: description: A collection of referential relation summary objects. properties: items: description: An array of referential relation summary objects. items: $ref: '#/components/schemas/MaskingPolicyReferentialRelationSummary' maxItems: 500 type: array required: - items type: object UnifiedAuditPolicyConfigDetails: description: 'The unified audit policy related configurations. ' properties: excludeDatasafeUser: description: Specifies whether the Data Safe service account on the target database should be excluded in the unified audit policy. enum: - ENABLED - DISABLED type: string type: object UpdateMaskingColumnDetails: description: Details to update a masking column. properties: isMaskingEnabled: description: "Indicates whether data masking is enabled for the masking column. Set it to false \nif you don't want to mask the column. \n" type: boolean maskingColumnGroup: description: "The group of the masking column. It's a masking group identifier and can be any \nstring of acceptable length. All the columns in a group are masked together to \nensure that the masked data across these columns continue to retain the same \nlogical relationship. For more details, check \nGroup Masking in the Data Safe documentation. \n" maxLength: 255 minLength: 0 type: string maskingFormats: description: "The masking formats to be assigned to the masking column. You can specify a \ncondition as part of each masking format. It enables you to do \nconditional masking \nso that you can mask the column data values differently using different \nmasking formats and the associated conditions. A masking format can have \none or more format entries. The combined output of all the format entries is \nused for masking. It provides the flexibility to define a masking format that \ncan generate different parts of a data value separately and then combine them \nto get the final data value for masking. \n" items: $ref: '#/components/schemas/MaskingFormat' maxItems: 1000 type: array objectType: description: The type of the object that contains the database column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' sensitiveTypeId: description: 'The OCID of the sensitive type to be associated with the masking column. Note that there will be no change in assigned masking format when sensitive type is changed. ' maxLength: 255 minLength: 1 type: string type: object SecurityPolicyEntryStateCollection: description: Collection of security policy entry state summary. properties: items: description: Array of security policy entry state summary. items: $ref: '#/components/schemas/SecurityPolicyEntryStateSummary' type: array required: - items type: object LibraryMaskingFormatSummary: description: Summary of a library masking format. properties: compartmentId: description: The OCID of the compartment that contains the library masking format. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the library masking format. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the library masking format. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the library masking format. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the library masking format. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' sensitiveTypeIds: description: An array of OCIDs of the sensitive types compatible with the library masking format. items: maxLength: 255 minLength: 1 type: string type: array source: description: Indicates whether the library masking format is user-defined or predefined. enum: - ORACLE - USER type: string x-obmcs-top-level-enum: '#/definitions/LibraryMaskingFormatSource' timeCreated: description: The date and time the library masking format was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string timeUpdated: description: The date and time the library masking format was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState - source type: object SqlFirewallAllowedSqlCollection: description: Collection of SQL Firewall allowed SQL statements. properties: items: description: Array of SQL Firewall allowed SQL statements. items: $ref: '#/components/schemas/SqlFirewallAllowedSqlSummary' type: array required: - items type: object SecurityPolicyCollection: description: Collection of security policy summary. properties: items: description: Array of security policy summary. items: $ref: '#/components/schemas/SecurityPolicySummary' type: array required: - items type: object FirewallConfigDetails: description: 'Details to update the SQL Firewall configuration. ' properties: excludeJob: description: Specifies whether the firewall should include or exclude the database internal job activities. enum: - EXCLUDED - INCLUDED type: string status: description: Specifies whether the firewall is enabled or disabled. enum: - ENABLED - DISABLED type: string violationLogAutoPurge: description: "Specifies whether Data Safe should automatically purge the violation logs \nfrom the database after collecting the violation logs and persisting them in Data Safe.\n" enum: - ENABLED - DISABLED type: string type: object DifferenceColumnSummary: description: Summary of a SDM masking policy difference column. properties: columnName: description: The name of the difference column. maxLength: 128 minLength: 1 type: string differenceType: description: 'The type of the SDM masking policy difference column. It can be one of the following three types: NEW: A new sensitive column in the sensitive data model that is not in the masking policy. DELETED: A column that is present in the masking policy but has been deleted from the sensitive data model. MODIFIED: A column that is present in the masking policy as well as the sensitive data model but some of its attributes have been modified. ' type: string x-obmcs-enumref: '#/definitions/DifferenceColumn/differenceType' key: description: The unique key that identifies the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string maskingColumnkey: description: The unique key that identifies the masking column represented by the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string objectName: description: The database object that contains the difference column. maxLength: 128 minLength: 1 type: string plannedAction: description: 'Specifies how to process the difference column. It''s set to SYNC by default. Use the PatchSdmMaskingPolicyDifferenceColumns operation to update this attribute. You can choose one of the following options: SYNC: To sync the difference column and update the masking policy to reflect the changes. NO_SYNC: To not sync the difference column so that it doesn''t change the masking policy. After specifying the planned action, you can use the ApplySdmMaskingPolicyDifference operation to automatically process the difference columns. ' type: string x-obmcs-enumref: '#/definitions/DifferenceColumn/plannedAction' schemaName: description: The database schema that contains the difference column. maxLength: 128 minLength: 1 type: string sensitiveColumnkey: description: The unique key that identifies the sensitive column represented by the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the difference column. maxLength: 255 minLength: 1 type: string syncStatus: description: "Indicates if the difference column has been processed.Use GetDifferenceColumn operation to track whether the difference column has \nalready been processed and applied to the masking policy.\n" type: string x-obmcs-enumref: '#/definitions/DifferenceColumn/syncStatus' timeLastSynced: description: The date and time the SDM masking policy difference column was last synced, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - key - differenceType - schemaName - objectName - columnName - plannedAction - syncStatus type: object FindingsChangeAuditLogSummary: description: Summary of audit log of risk updates of findings of specified security assessment. properties: assessmentId: description: The OCID of the latest security assessment. maxLength: 255 minLength: 1 type: string findingKey: description: The unique key that identifies the finding. maxLength: 255 minLength: 1 type: string findingTitle: description: The short title for the finding whose risk is being modified. type: string isRiskDeferred: description: "Determines if the user has deferred the risk level of this finding when he is ok with it \nand does not plan to do anything about it.\n" type: boolean justification: description: The justification given by the user for accepting or modifying the risk level. maxLength: 4000 minLength: 1 type: string key: description: The unique key that identifies the finding risk change. maxLength: 255 minLength: 1 type: string modifiedBy: description: The user who initiated change of risk level of the finding maxLength: 128 minLength: 1 type: string oracleDefinedSeverity: description: The severity of the finding as determined by security assessment by Oracle. type: string x-obmcs-enumref: '#/definitions/Finding/severity' previousSeverity: description: If the risk level is changed more than once, the previous modified value. type: string x-obmcs-enumref: '#/definitions/Finding/severity' severity: description: The original severity / risk level of the finding as determined by security assessment. type: string x-obmcs-enumref: '#/definitions/Finding/severity' targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string timeUpdated: description: 'The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeValidUntil: description: 'The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the risk level change as updated by user is valid until. After this date passes, the risk level will be that of what is determined by the latest security assessment. ' format: date-time type: string required: - key - findingKey - findingTitle - assessmentId - targetId - severity - oracleDefinedSeverity - previousSeverity - isRiskDeferred - justification - timeUpdated - modifiedBy type: object TargetDatabaseGroupCollection: description: The results of a target database group search. Contains target database group summary details. properties: items: description: An array of target database group summary items. items: $ref: '#/components/schemas/TargetDatabaseGroupSummary' type: array required: - items type: object CollectedAuditVolumeCollection: description: Collection of collected audit volume summary. properties: items: description: Array of collected audit volume summary. items: $ref: '#/components/schemas/CollectedAuditVolumeSummary' type: array required: - items type: object MaskingPolicyHealthReportSummary: description: Summary of a masking policy health report. properties: compartmentId: description: The OCID of the compartment that contains the health report. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking health report. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the health report. maxLength: 255 minLength: 1 type: string errorCount: description: The count of errors in the masking health report. format: int64 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the health report. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the health report. type: string x-obmcs-enumref: '#/definitions/MaskingPolicyHealthReport/lifecycleState' maskingPolicyId: description: The OCID of the masking policy. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database for which this report was created. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string warningCount: description: The count of warnings in the masking health report. format: int64 type: integer required: - id - maskingPolicyId - targetId - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags type: object SensitiveSchemaSummary: description: Summary of a sensitive schema present in a sensitive data model. properties: schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string required: - schemaName type: object UserAssessmentSummary: description: The summary of the user assessment. properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the user assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the user assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the user assessment. maxLength: 255 minLength: 1 type: string ignoredAssessmentIds: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array ignoredTargets: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array isBaseline: description: Indicates if the assessment is a baseline assessment. This applies to saved user assessments only. type: boolean isDeviatedFromBaseline: description: Indicates if the assessment has deviated from the baseline. type: boolean lastComparedBaselineId: description: The OCID of the last user assessment baseline against which the latest assessment was compared. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the user assessment. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the user assessment. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/UserAssessmentLifecycleState' schedule: description: 'Schedule to save the assessment periodically in the specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a user assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a user assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a user assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string scheduleAssessmentId: description: The OCID of the user assessment that created this scheduled save assessment. maxLength: 255 minLength: 1 type: string statistics: additionalProperties: additionalProperties: description: 'Value of the map as key-pair values. Example: `{"critical": "users"}` ' type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object description: "Map that contains maps of values.\n Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n" type: object targetDatabaseGroupId: description: The OCID of target database group. maxLength: 255 minLength: 1 type: string targetIds: description: Array of database target OCIDs. items: maxLength: 255 minLength: 1 type: string type: array targetType: description: Indicates whether the user assessment is for a target database or a target database group. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/UserAssessmentTargetType' timeCreated: description: The date and time the user assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeLastAssessed: description: The date and time the user assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The last date and time the user assessment was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string triggeredBy: description: Indicates whether the user assessment was created by the system or the user. enum: - USER - SYSTEM type: string type: description: "The type of the user assessment. The possible types are:\n\nLATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment.\nSAVED: A saved user assessment. All user assessments are saved in the user assessment history.\nSAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database.\nCOMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. \n It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.\n" enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT type: string required: - compartmentId - displayName - id - lifecycleState - timeCreated - timeUpdated - type type: object AuditProfileAnalyticCollection: description: 'Details of audit profile analytic summary. ' properties: items: description: Array of audit profile aggregration data. items: $ref: '#/components/schemas/AuditProfileAggregationItems' type: array required: - items type: object AuditPolicySummary: description: 'The resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on available audit policies, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). ' properties: auditSpecifications: description: 'Represents all available audit policy specifications relevant for the target database. For more details on available audit polcies, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). ' items: $ref: '#/components/schemas/AuditSpecification' type: array compartmentId: description: The OCID of the compartment containing the audit policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit policy. maxLength: 255 minLength: 1 type: string isDataSafeServiceAccountExcluded: description: Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies. type: boolean lifecycleDetails: description: Details about the current state of the audit policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit policy. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/AuditPolicyLifecycleState' targetId: description: The OCID of the target for which the audit policy is created. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the the audit policy was created, in the format defined by RFC3339. format: date-time type: string timeLastProvisioned: description: Indicates the last provisioning time of audit policies on the target, in the format defined by RFC3339. format: date-time type: string timeLastRetrieved: description: The time when the audit policies was last retrieved from this target, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the audit policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState - targetId - isDataSafeServiceAccountExcluded type: object SectionStatistics: description: Statistics showing the number of findings with a particular risk level for each category. properties: auditingFindingsCount: description: The number of findings in the Auditing category. type: integer authorizationControlFindingsCount: description: The number of findings in the Authorization Control category. type: integer dataEncryptionFindingsCount: description: The number of findings in the Data Encryption category. type: integer dbConfigurationFindingsCount: description: The number of findings in the Database Configuration category. type: integer fineGrainedAccessControlFindingsCount: description: The number of findings in the Fine-Grained Access Control category. type: integer privilegesAndRolesFindingsCount: description: The number of findings in the Privileges and Roles category. type: integer targetsCount: description: The number of targets that contributed to the counts at this risk level. type: integer userAccountsFindingsCount: description: The number of findings in the User Accounts category. type: integer type: object CreateTargetAlertPolicyAssociationDetails: description: 'The details used to create a new target-alert policy association. ' properties: compartmentId: description: The OCID of the compartment where the target-alert policy association is created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Describes the target-alert policy association. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target-alert policy association. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: Indicates if the target-alert policy association is enabled or disabled by user. type: boolean policyId: description: The OCID of the alert policy. example: ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target or target database group. example: ocid1.datasafetarget.oc1.dev2.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the alert policy association. Default is considered as TARGET_DATABASE. type: string x-obmcs-enumref: '#/definitions/TargetAlertPolicyAssociation/targetType' required: - policyId - targetId - isEnabled - compartmentId type: object UpdateReportDetails: description: The details for updating the report. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object UpdateSensitiveTypeGroupDetails: description: Details to update a sensitive type group. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type group. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type group. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object MaskedColumnCollection: description: A collection of masking column summary objects. properties: items: description: An array of masking column summary objects. items: $ref: '#/components/schemas/MaskedColumnSummary' type: array required: - items type: object PatchDiscoveryJobResultDetails: description: Details to patch discovery results. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object ProfileAggregation: description: "The profile aggregation provides information about the user profiles available on the database.\nFor example, the user profile details include how many users have a given profile assigned \nand how many profiles have password verification function.\n" properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object items: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: additionalProperties: type: object type: object type: array required: - items type: object AuditTrailAggregationItems: description: Details of audit trail aggregation items. properties: count: description: Total count of aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/AuditTrailDimensions' type: object AuditEventSummary: description: The resource represents the audit events collected from the target database by Oracle Data Safe. properties: actionTaken: description: The action taken for this audit event. maxLength: 512 minLength: 1 type: string applicationContexts: description: Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=) format. maxLength: 4000 minLength: 1 type: string auditEventTime: description: The time that the audit event occurs in the target database. format: date-time type: string auditLocation: description: The location of the audit. Currently the value is audit table. enum: - AUDIT_TABLE type: string auditPolicies: description: Comma-seperated list of audit policies that caused the current audit event. maxLength: 4000 minLength: 1 type: string auditTrailId: description: The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated. maxLength: 255 minLength: 1 type: string auditType: description: The type of the auditing. enum: - STANDARD - FINE_GRAINED - XS - DATABASE_VAULT - LABEL_SECURITY - RMAN - DATAPUMP - DIRECT_PATH_API type: string clientHostname: description: The name of the host machine from which the session was spawned. maxLength: 1024 minLength: 1 type: string clientId: description: The client identifier in each Oracle session. maxLength: 1024 minLength: 1 type: string clientIp: description: The IP address of the host machine from which the session was spawned. maxLength: 255 minLength: 1 type: string clientProgram: description: The application from which the audit event was generated. For example SQL Plus or SQL Developer. maxLength: 512 minLength: 1 type: string commandParam: description: List of bind variables associated with the command text. maxLength: 32767 minLength: 1 type: string commandText: description: The SQL associated with the audit event. maxLength: 32767 minLength: 1 type: string compartmentId: description: The OCID of the compartment containing the audit event. The compartment is the same as that of audit profile of the target database resource. maxLength: 100 minLength: 1 type: string databaseType: description: "The type of the target database that was audited. Allowed values are\n - DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services.\n - AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases.\n - INSTALLED_DATABASE - Represents databases running on-premises or on compute instances.\n" enum: - DATABASE_CLOUD_SERVICE - AUTONOMOUS_DATABASE - INSTALLED_DATABASE type: string databaseUniqueName: description: Unique name of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string dbUserName: description: The name of the database user whose actions were audited. maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object errorCode: description: Oracle Error code generated by the action. Zero indicates the action was successful. maxLength: 30 minLength: 1 type: string errorMessage: description: The detailed message on why the error occurred. maxLength: 4000 minLength: 1 type: string eventName: description: The name of the detail action executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX. maxLength: 1024 minLength: 1 type: string extendedEventAttributes: description: List of all other attributes of the audit event seperated by a colon other than the one returned in audit record. maxLength: 32767 minLength: 1 type: string externalUserId: description: The user ID of the external user of the audit event. maxLength: 255 minLength: 1 type: string fgaPolicyName: description: Fine-grained auditing (FGA) policy name that generated this audit record. maxLength: 128 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit event. maxLength: 255 minLength: 1 type: string isAlerted: description: Indicates whether an alert was raised for this audit event. type: boolean objectName: description: The name of the object affected by the action. maxLength: 1024 minLength: 1 type: string objectOwner: description: The schema name of the object affected by the action. maxLength: 1024 type: string objectType: description: The type of the object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY. maxLength: 255 minLength: 1 type: string operation: description: The name of the action executed by the user on the target database. For example ALTER, CREATE or DROP. maxLength: 255 minLength: 1 type: string operationStatus: description: Indicates whether the operation was a success or a failure. enum: - SUCCESS - FAILURE type: string osTerminal: description: The operating system terminal of the user session. maxLength: 255 minLength: 1 type: string osUserName: description: The name of the operating system user for the database session. maxLength: 1024 minLength: 1 type: string peerTargetDatabaseKey: description: The secondary id assigned for the peer database registered with Data Safe. type: integer targetClass: description: The class of the target that was audited. enum: - DATABASE type: string targetId: description: The OCID of the target database that was audited. maxLength: 255 minLength: 1 type: string targetName: description: The name of the target database that was audited. maxLength: 255 minLength: 1 type: string targetUser: description: The user on whom the GRANT/REVOKE/AUDIT/NOAUDIT statement was executed. maxLength: 128 minLength: 1 type: string timeCollected: description: The timestamp when this audit event was collected from the target database by Data Safe. format: date-time type: string trailSource: description: The underlying source of unified audit trail. enum: - TABLE - FILE type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailSource' required: - id - compartmentId - targetId - targetName - databaseType - auditEventTime - timeCollected - isAlerted type: object DiscoveryJobCollection: description: A collection of discovery job summary objects. properties: items: description: An array of discovery job summary objects. items: $ref: '#/components/schemas/DiscoveryJobSummary' type: array required: - items type: object MaskingSchemaSummary: description: Summary of a masking schema present in masking policy. properties: schemaName: description: The database schema that contains the masking column. maxLength: 128 minLength: 1 type: string required: - schemaName type: object ChangeSensitiveDataModelCompartmentDetails: description: Details to change the compartment of a sensitive data model. properties: compartmentId: description: The OCID of the compartment where the sensitive data model should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object SecurityFeatureSummary: description: The details of database security feature usage available on a given compartment. properties: assessmentId: description: The OCID of the assessment that generates this security feature usage result. maxLength: 255 minLength: 1 type: string columnEncryption: description: The usage of security feature - Column Encryption. enum: - ENABLED - DISABLED - NONE type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string databaseVault: description: The usage of security feature - Database Vault. enum: - ENABLED - DISABLED - NONE type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object externalAuthentication: description: The usage of security feature - External Authentication. enum: - ENABLED - DISABLED - NONE type: string fineGrainedAudit: description: The usage of security feature - Fine Grained Audit. enum: - ENABLED - DISABLED - NONE type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object globalAuthentication: description: The usage of security feature - Global Authentication. enum: - ENABLED - DISABLED - NONE type: string networkEncryption: description: The usage of security feature - Network Encryption. enum: - ENABLED - DISABLED - NONE type: string passwordAuthentication: description: The usage of security feature - Password Authentication. enum: - ENABLED - DISABLED - NONE type: string privilegeAnalysis: description: The usage of security feature - Privilege Analysis. enum: - ENABLED - DISABLED - NONE type: string tablespaceEncryption: description: The usage of security feature - Tablespace Encryption. enum: - ENABLED - DISABLED - NONE type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string traditionalAudit: description: The usage of security feature - Traditional Audit. enum: - ENABLED - DISABLED - NONE type: string unifiedAudit: description: The usage of security feature - Unified Audit. enum: - ENABLED - DISABLED - NONE type: string required: - compartmentId - targetId - assessmentId - unifiedAudit - fineGrainedAudit - traditionalAudit - databaseVault - privilegeAnalysis - tablespaceEncryption - columnEncryption - networkEncryption - passwordAuthentication - globalAuthentication - externalAuthentication type: object ProvisionAuditConditions: description: Represents audit policies with corresponding audit provisioning conditions. properties: auditPolicyName: description: 'Indicates the audit policy name available for provisioning from Data Safe. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. ' maxLength: 512 minLength: 1 type: string enableConditions: description: 'Indicates the users/roles in the target database for which the audit policy will be enforced, and the success/failure event condition to generate the audit event. ' items: $ref: '#/components/schemas/EnableConditions' type: array x-default-description: 'null' isEnabled: description: 'Indicates whether the policy has to be enabled or disabled in the target database. Set this to true if you want the audit policy to be enabled in the target database. If the seeded audit policy is not already created in the database, the provisioning creates and enables them. If this is set to false, the policy will be disabled in the target database. ' type: boolean isPrivUsersManagedByDataSafe: description: Indicates whether the privileged user list is managed by Data Safe. type: boolean required: - auditPolicyName - isPrivUsersManagedByDataSafe - isEnabled type: object CreateMaskingColumnDetails: description: "Details to create a new masking column. You can use this to add a parent column only. \nIt automatically adds the child columns from the associated sensitive data model or \ntarget database. If you provide the sensitiveTypeId attribute but not the maskingFormats \nattribute, it automatically assigns the default masking format associated with the \nspecified sensitive type. Alternatively, if you provide the maskingFormats attribute, \nthe specified masking formats are assigned to the column.\n\nUsing the maskingFormats attribute, you can assign one or more masking formats to a \ncolumn. You can specify a condition as part of each masking format. It enables you \nto do conditional masking\nso that you can mask the column data values differently using different masking formats \nand the associated conditions. A masking format can have one or more format entries. \nThe combined output of all the format entries is used for masking. It provides the \nflexibility to define a masking format that can generate different parts of a data \nvalue separately and then combine them to get the final data value for masking.\n\nYou can use the maskingColumnGroup attribute to group the columns that you would like \nto mask together. It enables you to do\ngroup or compound masking \nthat ensures that the masked data across the columns in a group continue to retain \nthe same logical relationship.\n" properties: columnName: description: "The name of the database column. This attribute cannot be updated for an existing \n masking column. Note that the same name is used for the masking column. There \n is no separate displayName attribute for the masking column. \n" maxLength: 128 minLength: 1 type: string isMaskingEnabled: default: true description: "Indicates whether data masking is enabled for the masking column. Set it to false if \nyou don't want to mask the column. \n" type: boolean maskingColumnGroup: description: "The group of the masking column. It's a masking group identifier and can be any string \nof acceptable length. All the columns in a group are masked together to ensure that \nthe masked data across these columns continue to retain the same logical relationship. \nFor more details, check \nGroup Masking in the Data Safe documentation. \n" maxLength: 255 minLength: 0 type: string x-default-description: The columnGroup will be set to null by default. maskingFormats: description: "The masking formats to be assigned to the masking column. You can specify a condition \nas part of each masking format. It enables you to do \nconditional masking \nso that you can mask the column data values differently using different masking \nformats and the associated conditions. A masking format can have one or more format \nentries. The combined output of all the format entries is used for masking. It \nprovides the flexibility to define a masking format that can generate different parts \nof a data value separately and then combine them to get the final data value for masking. \n" items: $ref: '#/components/schemas/MaskingFormat' maxItems: 1000 type: array objectName: description: The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column. maxLength: 128 minLength: 1 type: string objectType: default: TABLE description: The type of the object that contains the database column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' schemaName: description: The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column. maxLength: 128 minLength: 1 type: string sensitiveTypeId: description: "The OCID of the sensitive type to be associated with the masking column. Note that \nif the maskingFormats attribute isn't provided while creating a masking column, \nthe default masking format associated with the specified sensitive type is assigned \nto the masking column. \n" maxLength: 255 minLength: 1 type: string x-default-description: The sensitiveTypeId will be set to null by default. required: - schemaName - columnName - objectName type: object SqlFirewallPolicyCollection: description: Collection of SQL Firewall policy summary. properties: items: description: Array of SQL Firewall policy summary. items: $ref: '#/components/schemas/SqlFirewallPolicySummary' type: array required: - items type: object columnFilter: description: Filters that are applied to the data at the column level. properties: expressions: description: An array of expressions based on the operator type. A filter may have one or more expressions. items: maxLength: 255 minLength: 1 type: string type: array fieldName: description: Name of the column on which the filter must be applied. maxLength: 255 minLength: 1 type: string isEnabled: description: Indicates whether the filter is enabled. Values can either be 'true' or 'false'. type: boolean isHidden: default: true description: Indicates whether the filter is hidden. Values can either be 'true' or 'false'. type: boolean operator: description: Specifies the type of operator that must be applied for example in, eq etc. enum: - IN - EQ - EQ_CS - GT - GE - LT - LE - AND - OR - NE - CO - CO_CS - NOT - NOT_IN - PR - IN_SET - NOT_IN_SET type: string required: - fieldName - operator - expressions - isEnabled - isHidden type: object CreateDiscoveryJobDetails: description: Details to create a new data discovery job. properties: compartmentId: description: The OCID of the compartment where the discovery job resource should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object discoveryType: default: ALL description: 'The type of the discovery job. It defines the job''s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. ' type: string x-obmcs-enumref: '#/definitions/DiscoveryJob/discoveryType' displayName: description: A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string x-default-description: DiscoveryJob_ freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isAppDefinedRelationDiscoveryEnabled: default: false description: 'Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It''s disabled by default and should be used only if there is a need to identify application-level relationships. ' type: boolean isIncludeAllSchemas: default: false description: 'Indicates if all the schemas should be scanned by the discovery job. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). If both attributes are not provided, the configuration from the sensitive data model is used. ' type: boolean isIncludeAllSensitiveTypes: default: false description: 'Indicates if all the existing sensitive types should be used by the discovery job. If it''s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used. ' type: boolean isSampleDataCollectionEnabled: default: false description: 'Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it''s disabled by default and should be used only if it''s acceptable to store sample data in Data Safe''s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. ' type: boolean schemasForDiscovery: description: 'The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas. ' items: maxLength: 128 minLength: 1 type: string type: array sensitiveDataModelId: description: The OCID of the sensitive data model. maxLength: 255 minLength: 1 type: string sensitiveTypeGroupIdsForDiscovery: description: 'The OCIDs of the sensitive type groups to be used by the discovery job. All the sensitive types present in sensitive type group will be used for discovery. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array sensitiveTypeIdsForDiscovery: description: 'The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types. ' items: maxLength: 255 minLength: 1 type: string type: array tablesForDiscovery: description: "The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence \nof explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.\n" items: $ref: '#/components/schemas/TablesForDiscovery' maxItems: 1000 type: array required: - sensitiveDataModelId - compartmentId type: object AlertPolicyRuleCollection: description: Collection of alert policy rules summary. properties: items: description: Array of alert policy rules summary items: $ref: '#/components/schemas/AlertPolicyRuleSummary' type: array required: - items type: object PeerTargetDatabaseSummary: description: The details of the peer target database in Data Safe. properties: databaseUniqueName: description: Unique name of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string dataguardAssociationId: description: The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. maxLength: 255 minLength: 1 type: string description: description: The description of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the peer target database in Data Safe. maxLength: 255 minLength: 1 type: string key: description: The secondary id assigned for the peer target database in Data Safe. type: integer lifecycleDetails: description: Details about the current state of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the peer target database in Data Safe. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/TargetDatabaseLifecycleState' role: description: Role of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time of the peer target database registration in Data Safe. format: date-time type: string required: - key - displayName - dataguardAssociationId - lifecycleState - timeCreated type: object SensitiveDataModelSummary: description: Summary of a sensitive data model. properties: appSuiteName: description: 'The application suite name identifying a collection of applications. The default value is GENERIC. It''s useful only if maintaining a sensitive data model for a suite of applications. ' type: string compartmentId: description: The OCID of the compartment that contains the sensitive data model. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive data model. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive data model. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive data model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the sensitive data model. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' targetId: description: 'The OCID of the reference target database associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database. ' maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the sensitive data model was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive data model was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - targetId - timeCreated - timeUpdated - lifecycleState - appSuiteName type: object SqlCollectionAggregation: description: The details of SQL collections. properties: count: description: The total count of the aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/SqlCollectionDimensions' required: - dimensions - count type: object WorkRequestSummary: description: Summary of a work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. ' type: string id: description: The OCID of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - ENABLE_DATA_SAFE_CONFIGURATION - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - CHANGE_PRIVATE_ENDPOINT_COMPARTMENT - CREATE_ONPREM_CONNECTOR - UPDATE_ONPREM_CONNECTOR - DELETE_ONPREM_CONNECTOR - UPDATE_ONPREM_CONNECTOR_WALLET - CHANGE_ONPREM_CONNECTOR_COMPARTMENT - PROVISION_POLICY - RETRIEVE_POLICY - UPDATE_POLICY - CHANGE_POLICY_COMPARTMENT - CREATE_TARGET_DATABASE - UPDATE_TARGET_DATABASE - ACTIVATE_TARGET_DATABASE - DEACTIVATE_TARGET_DATABASE - UPDATE_TARGET_DATABASE_PRIVILEGE - DELETE_TARGET_DATABASE - CHANGE_TARGET_DATABASE_COMPARTMENT - REFRESH_DICTIONARY_CACHE - CREATE_PEER_TARGET_DATABASE - UPDATE_PEER_TARGET_DATABASE - DELETE_PEER_TARGET_DATABASE - REFRESH_TARGET_DATABASE - CREATE_USER_ASSESSMENT - ASSESS_USER_ASSESSMENT - CREATE_SNAPSHOT_USER_ASSESSMENT - CREATE_SCHEDULE_USER_ASSESSMENT - COMPARE_WITH_BASELINE_USER_ASSESSMENT - DELETE_USER_ASSESSMENT - UPDATE_USER_ASSESSMENT - CHANGE_USER_ASSESSMENT_COMPARTMENT - SET_USER_ASSESSMENT_BASELINE - UNSET_USER_ASSESSMENT_BASELINE - GENERATE_USER_ASSESSMENT_REPORT - CREATE_SECURITY_ASSESSMENT - CREATE_SECURITY_ASSESSMENT_NOW - ASSESS_SECURITY_ASSESSMENT - CREATE_SNAPSHOT_SECURITY_ASSESSMENT - CREATE_SCHEDULE_SECURITY_ASSESSMENT - COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT - DELETE_SECURITY_ASSESSMENT - UPDATE_SECURITY_ASSESSMENT - UPDATE_FINDING_RISK - CHANGE_SECURITY_ASSESSMENT_COMPARTMENT - SET_SECURITY_ASSESSMENT_BASELINE - UNSET_SECURITY_ASSESSMENT_BASELINE - GENERATE_SECURITY_ASSESSMENT_REPORT - PATCH_CHECKS - UPDATE_FINDING_SEVERITY - APPLY_TEMPLATE - DELETE_SQL_FIREWALL_ALLOWED_SQL - BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL - BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL - CALCULATE_VOLUME - CALCULATE_COLLECTED_VOLUME - CREATE_DB_SECURITY_CONFIG - REFRESH_DB_SECURITY_CONFIG - UPDATE_DB_SECURITY_CONFIG - CHANGE_DB_SECURITY_CONFIG_COMPARTMENT - GENERATE_FIREWALL_POLICY - UPDATE_FIREWALL_POLICY - CHANGE_FIREWALL_POLICY_COMPARTMENT - DELETE_FIREWALL_POLICY - CREATE_SQL_COLLECTION - UPDATE_SQL_COLLECTION - START_SQL_COLLECTION - STOP_SQL_COLLECTION - DELETE_SQL_COLLECTION - CHANGE_SQL_COLLECTION_COMPARTMENT - REFRESH_SQL_COLLECTION_LOG_INSIGHTS - PURGE_SQL_COLLECTION_LOGS - REFRESH_VIOLATIONS - CREATE_ARCHIVAL - CREATE_SECURITY_POLICY - DELETE_SECURITY_POLICY - UPDATE_SECURITY_POLICY - CHANGE_SECURITY_POLICY_COMPARTMENT - UPDATE_SECURITY_POLICY_DEPLOYMENT - CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT - AUDIT_TRAIL - DELETE_AUDIT_TRAIL - DISCOVER_AUDIT_TRAILS - UPDATE_AUDIT_TRAIL - UPDATE_AUDIT_PROFILE - AUDIT_CHANGE_COMPARTMENT - CREATE_REPORT_DEFINITION - UPDATE_REPORT_DEFINITION - CHANGE_REPORT_DEFINITION_COMPARTMENT - DELETE_REPORT_DEFINITION - GENERATE_REPORT - GENERATE_PAGINATED_REPORT - CHANGE_REPORT_COMPARTMENT - DELETE_ARCHIVE_RETRIEVAL - CREATE_ARCHIVE_RETRIEVAL - UPDATE_ARCHIVE_RETRIEVAL - CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT - UPDATE_ALERT - TARGET_ALERT_POLICY_ASSOCIATION - CREATE_TARGET_DATABASE_GROUP - UPDATE_TARGET_DATABASE_GROUP - DELETE_TARGET_DATABASE_GROUP - CHANGE_TARGET_DATABASE_GROUP_COMPARTMENT - CREATE_SECURITY_POLICY_CONFIG - UPDATE_SECURITY_POLICY_CONFIG - DELETE_SECURITY_POLICY_CONFIG - CHANGE_SECURITY_POLICY_CONFIG_COMPARTMENT - CREATE_UNIFIED_AUDIT_POLICY - UPDATE_UNIFIED_AUDIT_POLICY - DELETE_UNIFIED_AUDIT_POLICY - CHANGE_UNIFIED_AUDIT_POLICY_COMPARTMENT - UPDATE_UNIFIED_AUDIT_POLICY_DEFINITION - DELETE_UNIFIED_AUDIT_POLICY_DEFINITION - CHANGE_UNIFIED_AUDIT_POLICY_DEFINITION_COMPARTMENT - FLEET_GENERATE_SECURITY_ASSESSMENT_REPORT - FLEET_GENERATE_USER_ASSESSMENT_REPORT - REFRESH_TARGET_DATABASE_GROUP_WITH_CHANGES - FETCH_AUDIT_POLICY_DETAILS - BULK_CREATE_UNIFIED_AUDIT_POLICY - SECURITY_POLICY_DEPLOYMENT_ACTIONS - PROVISION_SECURITY_POLICY_DEPLOYMENT - CREATE_SENSITIVE_DATA_MODEL - UPDATE_SENSITIVE_DATA_MODEL - DELETE_SENSITIVE_DATA_MODEL - UPLOAD_SENSITIVE_DATA_MODEL - GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD - CREATE_SENSITIVE_COLUMN - UPDATE_SENSITIVE_COLUMN - PATCH_SENSITIVE_COLUMNS - CREATE_DISCOVERY_JOB - DELETE_DISCOVERY_JOB - PATCH_DISCOVERY_JOB_RESULT - APPLY_DISCOVERY_JOB_RESULT - GENERATE_DISCOVERY_REPORT - CREATE_SENSITIVE_TYPE - UPDATE_SENSITIVE_TYPE - CREATE_MASKING_POLICY - UPDATE_MASKING_POLICY - DELETE_MASKING_POLICY - UPLOAD_MASKING_POLICY - GENERATE_MASKING_POLICY_FOR_DOWNLOAD - CREATE_MASKING_COLUMN - UPDATE_MASKING_COLUMN - PATCH_MASKING_COLUMNS - GENERATE_MASKING_REPORT - CREATE_LIBRARY_MASKING_FORMAT - UPDATE_LIBRARY_MASKING_FORMAT - ADD_COLUMNS_FROM_SDM - MASKING_JOB - CREATE_DIFFERENCE - DELETE_DIFFERENCE - UPDATE_DIFFERENCE - PATCH_DIFFERENCE - APPLY_DIFFERENCE - DELETE_MASKING_REPORT - MASK_POLICY_GENERATE_HEALTH_REPORT - MASK_POLICY_DELETE_HEALTH_REPORT - CREATE_SENSITIVE_TYPES_EXPORT - UPDATE_SENSITIVE_TYPES_EXPORT - BULK_CREATE_SENSITIVE_TYPES - CREATE_SENSITIVE_TYPE_GROUP - UPDATE_SENSITIVE_TYPE_GROUP - DELETE_SENSITIVE_TYPE_GROUP - DELETE_SENSITIVE_TYPE - PATCH_GROUPED_SENSITIVE_TYPES - CREATE_RELATION - DELETE_RELATION - ABORT_MASKING - CREATE_SECURITY_POLICY_REPORT - REFRESH_SECURITY_POLICY_CACHE - DELETE_SECURITY_POLICY_CACHE - CREATE_SCHEDULE - REMOVE_SCHEDULE_REPORT - UPDATE_ALL_ALERT - PATCH_TARGET_ALERT_POLICY_ASSOCIATION - UPDATE_TARGET_GROUP_AUDIT_PROFILE - CREATE_ATTRIBUTE_SET - UPDATE_ATTRIBUTE_SET - DELETE_ATTRIBUTE_SET - CHANGE_ATTRIBUTE_SET_COMPARTMENT - CREATE_REGISTRATION_POLICY - UPDATE_REGISTRATION_POLICY - DELETE_REGISTRATION_POLICY - CHANGE_REGISTRATION_POLICY_COMPARTMENT type: string percentComplete: description: Progress of the work request in percentage. format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - SUSPENDING - SUSPENDED type: string timeAccepted: description: 'The date and time the work request was accepted, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted type: object DatabaseSecurityConfigCollection: description: Collection of database security config summaries. properties: items: description: Array of database security config summaries. items: $ref: '#/components/schemas/DatabaseSecurityConfigSummary' type: array required: - items type: object ChangeRetentionDetails: description: Details for the audit retention months to be modified. properties: isOverrideGlobalRetentionSetting: description: "Indicates whether audit retention settings like online and offline months set at the \ntarget level override both the global settings and the target group level audit retention settings.\n" type: boolean offlineMonths: description: "Number of months the audit records will be stored offline in the offline archive.\n Minimum: 0; Maximum: 72 months.\n If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support.\n" format: int32 maximum: 168 minimum: 0 type: integer onlineMonths: description: 'Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months ' format: int32 maximum: 12 minimum: 1 type: integer type: object ChangeMaskingPolicyHealthReportCompartmentDetails: description: Details to change the compartment of a masking policy. properties: compartmentId: description: The OCID of the compartment where the masking policy should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object SqlCollection: description: "The resource represents SQL collection for a specific database user in a target. \nSqlCollection encapsulates the SQL commands issued in the user’s database sessions, and its execution context.\n" properties: compartmentId: description: The OCID of the compartment containing the SQL collection. maxLength: 100 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL collection. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL collection. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL collection. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the SQL collection in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the SQL collection. enum: - CREATING - UPDATING - COLLECTING - COMPLETED - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlCollectionLifecycleState' sqlLevel: description: 'Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string status: description: Specifies if the status of the SqlCollection. Enabled indicates that the collecting is in progress. enum: - ENABLED - DISABLED type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string timeCreated: description: The time that the SQL collection was created, in the format defined by RFC3339. format: date-time type: string timeLastStarted: description: The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339. format: date-time type: string timeLastStopped: description: The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the SQL collection was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState - targetId - dbUserName - status type: object DownloadUserAssessmentReportDetails: description: The details used to download a user assessment report. properties: format: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string required: - format type: object SensitiveDataModelCollection: description: A collection of sensitive data model summary objects. properties: items: description: An array of sensitive data model summary objects. items: $ref: '#/components/schemas/SensitiveDataModelSummary' type: array required: - items type: object DownloadDiscoveryReportDetails: description: Details to download a discovery report. properties: discoveryJobId: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string reportFormat: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string type: object CalculateAuditVolumeAvailableDetails: description: The details for calculating audit data volume on target. properties: auditCollectionStartTime: description: The date from which the audit trail must start collecting data in UTC, in the format defined by RFC3339. If not specified, this will default to the date based on the retention period. format: date-time type: string x-default-description: 'null' databaseUniqueName: description: Unique name of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string trailLocations: description: The trail locations for which the audit data volume has to be calculated. items: maxLength: 4000 minLength: 1 type: string type: array type: object SecurityPolicyEntryState: description: 'The resource represents the state of a specific entry type deployment on a target. ' properties: deploymentStatus: description: The current deployment status of the security policy deployment and the security policy entry associated. enum: - CREATED - MODIFIED - CONFLICT - CONNECTIVITY_ISSUE - UNSUPPORTED_SYNTAX - UNKNOWN_ERROR - UNAUTHORIZED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyEntryStateDeploymentStatus' deploymentStatusDetails: description: Details about the current deployment status. maxLength: 400 minLength: 1 type: string entryDetails: $ref: '#/components/schemas/EntryDetails' entryType: description: 'The security policy entry type. Allowed values: - FIREWALL_POLICY - The SQL Firewall policy entry type. - AUDIT_POLICY - The audit policy entry type. - CONFIG - Config changes deployment. ' enum: - FIREWALL_POLICY - AUDIT_POLICY - CONFIG type: string id: description: Unique id of the security policy entry state. maxLength: 255 minLength: 1 type: string securityPolicyDeploymentId: description: The OCID of the security policy deployment associated. maxLength: 255 minLength: 1 type: string securityPolicyEntryId: description: The OCID of the security policy entry type associated. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target on which the security policy is deployed. maxLength: 255 minLength: 1 type: string required: - id - securityPolicyEntryId - deploymentStatus - targetId - entryType type: object SensitiveObjectCollection: description: A collection of sensitive object summary objects. properties: items: description: An array of sensitive object summary objects. items: $ref: '#/components/schemas/SensitiveObjectSummary' type: array required: - items type: object SqlFirewallPolicy: description: 'The SQL Firewall policy resource contains the firewall policy metadata for a single user. ' properties: allowedClientIps: description: The list of allowed ip addresses for the SQL Firewall policy. items: maxLength: 128 minLength: 1 type: string maxItems: 1000 type: array allowedClientOsUsernames: description: The list of allowed operating system user names for the SQL Firewall policy. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array allowedClientPrograms: description: The list of allowed client programs for the SQL Firewall policy. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array compartmentId: description: The OCID of the compartment containing the SQL Firewall policy. maxLength: 100 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Firewall policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL Firewall policy. maxLength: 255 minLength: 1 type: string enforcementScope: description: Specifies the SQL Firewall policy enforcement option. enum: - ENFORCE_CONTEXT - ENFORCE_SQL - ENFORCE_ALL type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL Firewall policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the SQL Firewall policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the SQL Firewall policy. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallPolicyLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the SQL Firewall policy. maxLength: 255 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string status: description: Specifies whether the SQL Firewall policy is enabled or disabled. enum: - ENABLED - DISABLED type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time that the SQL Firewall policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the SQL Firewall policy was last updated, in the format defined by RFC3339. format: date-time type: string violationAction: description: Specifies the mode in which the SQL Firewall policy is enabled. enum: - BLOCK - OBSERVE type: string violationAudit: description: Specifies whether a unified audit policy should be enabled for auditing the SQL Firewall policy violations. enum: - ENABLED - DISABLED type: string required: - id - displayName - compartmentId - securityPolicyId - dbUserName - status - timeCreated - lifecycleState type: object MaskingPolicyCollection: description: A collection of masking policy summary objects. properties: items: description: An array of masking policy summary objects. items: $ref: '#/components/schemas/MaskingPolicySummary' type: array required: - items type: object ChangeSensitiveTypeCompartmentDetails: description: Details to change the compartment of a sensitive type. properties: compartmentId: description: The OCID of the compartment where the sensitive type should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object PatchSqlFirewallAllowedSqlDetails: description: The details used to delete multiple allowed sqls. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array sqlFirewallPolicyId: description: The OCID of the SQL firewall policy whose allowed SQL needs to be deleted. maxLength: 255 minLength: 1 type: string required: - items - sqlFirewallPolicyId type: object SqlFirewallAllowedSqlDimensions: description: The dimensions available for SQL Firewall allow SQL analytics. properties: dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string lifecycleState: description: The current state of the SQL Firewall allowed SQL. enum: - ACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallAllowedSqlLifecycleState' sqlFirewallPolicyId: description: The OCID of the SQL Firewall policy corresponding to the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string type: object CreateTargetDatabaseGroupDetails: description: The details used to create the target database group. properties: compartmentId: description: The OCID of the compartment to create the target database group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the target database group (optional). maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The name of the target database group. maxLength: 255 minLength: 1 type: string x-default-description: This field will be assigned a value following the format TargetDatabaseGroup . freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object matchingCriteria: $ref: '#/components/schemas/MatchingCriteria' required: - compartmentId - displayName - matchingCriteria type: object ModifiedAttributes: description: 'The attributes of a sensitive column that have been modified in the target database. It''s populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes. ' properties: appDefinedChildColumnKeys: description: Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array dbDefinedChildColumnKeys: description: Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array type: object CreateRegistrationPolicyDetails: description: 'The details required to create a new registration policy. This object contains the necessary information to create a registration policy, including the compartment ID, resource ID, and features. ' properties: canOverrideFeatures: description: Indicates whether features will be overridden for all targets. type: boolean compartmentId: description: The OCID of the compartment where the registration policy will be created. maxLength: 255 minLength: 1 type: string connectionOption: $ref: '#/components/schemas/PolicyConnectionOption' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the registration policy. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the registration policy. maxLength: 255 minLength: 1 type: string features: description: The Data Safe features granted to the databases registering under the registration policy. items: enum: - ASSESSMENT - AUDIT_COLLECTION - AUDIT_SETTING - DATA_DISCOVERY - MASKING - SQL_FIREWALL - ALL type: string x-obmcs-top-level-enum: '#/definitions/RegistrationPolicyFeatures' type: array uniqueItems: true freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object resourceId: description: The OCID of the resource used in the registration policy. maxLength: 255 minLength: 1 type: string required: - compartmentId - resourceId - features type: object DatabaseViewAccessEntryCollection: description: A collection of database view access summary objects. properties: items: description: An array of database view access summary objects. items: $ref: '#/components/schemas/DatabaseViewAccessEntrySummary' type: array required: - items type: object ChangeAttributeSetCompartmentDetails: description: The compartment where the attribute set will move to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the new compartment were attribute set resource would move. ' example: ocid1.compartment.dev.absgk5rrqhzsicpsmrixf6n27eng7kgkuzesiswmukwarqeuedcuzdxy52wa maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SdmMaskingPolicyDifference: description: A resource that tracks the differences between sensitive columns in the sensitive data model and masking columns in the masking policy properties: compartmentId: description: The OCID of the compartment that contains the Sensitive data model and masking policy difference resource. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object differenceType: description: 'The type of the SDM masking policy difference. It defines the difference scope. NEW identifies new sensitive columns in the sensitive data model that are not in the masking policy. DELETED identifies columns that are present in the masking policy but have been deleted from the sensitive data model. MODIFIED identifies columns that are present in the sensitive data model as well as the masking policy but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. ' enum: - ALL - NEW - MODIFIED - DELETED type: string displayName: description: The display name of the SDM masking policy difference. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Sensitive data model and masking policy difference resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the SDM masking policy difference. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string maskingPolicyId: description: The OCID of the masking policy associated with the SDM masking policy difference. maxLength: 255 minLength: 1 type: string sensitiveDataModelId: description: The OCID of the sensitive data model associated with the SDM masking policy difference. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the SDM masking policy difference was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeCreationStarted: description: The date and time the SDM masking policy difference creation started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - differenceType - displayName - lifecycleState - timeCreated - timeCreationStarted - sensitiveDataModelId - maskingPolicyId type: object UpdateColumnSourceDetails: description: Details to update the column source of a masking policy. discriminator: propertyName: columnSource properties: columnSource: description: The source of masking columns. enum: - TARGET - SENSITIVE_DATA_MODEL type: string required: - columnSource type: object UpdateOnPremConnectorDetails: description: The details used to update a on-premises connector. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the on-premises connector. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the on-premises connector. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object SecurityPolicyConfigSummary: description: 'The Data Safe resource represents the common configurations corresponding to the associated security policy. ' properties: compartmentId: description: The OCID of the compartment containing the security policy configuration. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy configuration. maxLength: 255 minLength: 1 type: string firewallConfig: $ref: '#/components/schemas/FirewallConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy configuration. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy configuration. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy configuration. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyConfigLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the security policy configuration. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the security policy configuration was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the security policy configuration was last updated, in the format defined by RFC3339. format: date-time type: string unifiedAuditPolicyConfig: $ref: '#/components/schemas/UnifiedAuditPolicyConfig' required: - id - displayName - compartmentId - securityPolicyId - timeCreated - lifecycleState type: object SensitiveColumnSummary: description: Summary of a sensitive column present in a sensitive data model. properties: appName: description: 'The name of the application associated with the sensitive column. It''s useful when the application name is different from the schema name. Otherwise, it can be ignored. ' maxLength: 128 minLength: 1 type: string columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string estimatedDataValueCount: description: The estimated number of data values the column has in the associated database. format: int64 type: integer key: description: The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the sensitive column. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the sensitive column. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveColumnLifecycleState' objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string parentColumnKeys: description: Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. items: maxLength: 255 minLength: 1 type: string type: array relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sampleDataValues: description: 'Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. ' items: maxLength: 4000 minLength: 1 type: string type: array schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveDataModelId: description: The OCID of the sensitive data model that contains the sensitive column. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the sensitive column. maxLength: 255 minLength: 1 type: string source: description: 'The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually. ' enum: - MANUAL - DISCOVERY type: string status: description: 'The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again. ' enum: - VALID - INVALID type: string timeCreated: description: 'The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was created in the sensitive data model. ' format: date-time type: string timeUpdated: description: 'The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was last updated in the sensitive data model. ' format: date-time type: string required: - key - sensitiveDataModelId - lifecycleState - timeCreated - timeUpdated - appName - schemaName - objectName - columnName - objectType - dataType - status - source - relationType - estimatedDataValueCount type: object LibraryMaskingFormat: description: 'A library masking format is a masking format stored in an Oracle Cloud Infrastructure compartment and can be used in multiple masking policies. If you want to use the same masking logic for multiple masking columns or even in multiple masking policies, you can create a library masking format and assign it to masking columns as needed. It helps you avoid defining the same masking logic again and again. Oracle Data Safe provides a set of predefined library masking formats to mask common sensitive and personal data, such as names, national identifiers, credit card numbers, and phone numbers. To meet your specific requirements, you can easily create new library masking formats and use them in your masking policies. ' properties: compartmentId: description: The OCID of the compartment that contains the library masking format. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the library masking format. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the library masking format. maxLength: 255 minLength: 1 type: string formatEntries: description: An array of format entries. The combined output of all the format entries is used for masking. items: $ref: '#/components/schemas/FormatEntry' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the library masking format. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the library masking format. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' sensitiveTypeIds: description: An array of OCIDs of the sensitive types compatible with the library masking format. items: maxLength: 255 minLength: 1 type: string type: array source: description: Specifies whether the library masking format is user-defined or predefined. enum: - ORACLE - USER type: string x-obmcs-top-level-enum: '#/definitions/LibraryMaskingFormatSource' timeCreated: description: The date and time the library masking format was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string timeUpdated: description: The date and time the library masking format was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState - source type: object UserAccessAnalyticsCollection: description: A collection of user access analytics summary objects. properties: items: description: An array of user access analytics summary objects. items: $ref: '#/components/schemas/UserAccessAnalyticsSummary' type: array required: - items type: object ChangeUnifiedAuditPolicyDefinitionCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the unified audit policy definition. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DatabaseSecurityConfigSummary: description: "Database Security Configurations resource represents the target database configurations. \nIncluded in the Database Security Configurations are the SQL Firewall configurations such as\nthe status of the firewall, the time that the firewall status was last updated, violation log auto purge settings, etc.\n" properties: compartmentId: description: The OCID of the compartment containing the database security config. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the database security config. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the database security config. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the database security config. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the database security config in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the database security config. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSecurityConfigLifecycleState' sqlFirewallConfig: $ref: '#/components/schemas/SqlFirewallConfig' targetId: description: The target OCID corresponding to the database security config. maxLength: 255 minLength: 1 type: string timeCreated: description: The time that the database security config was created, in the format defined by RFC3339. format: date-time type: string timeLastRefreshed: description: The last date and time the database security config was refreshed, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the database security configuration was last updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - targetId - timeCreated - lifecycleState type: object WorkRequestLogEntry: description: A log entry related to a work request. properties: message: description: A human-readable log entry. type: string timestamp: description: The date and time the log entry was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - message - timestamp type: object RunSecurityAssessmentDetails: description: The details required to create an on-demand saved security assessment. properties: compartmentId: description: The OCID of the compartment that contains the security assessment. maxLength: 255 minLength: 1 type: string x-default-description: This field is set to latest assessment compartment if a value is not provided. definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The display name of the security assessment. maxLength: 255 minLength: 1 type: string x-default-description: This field is set to a value in the format UA if a value is not provided. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. ' type: string id: description: The OCID of the work request. type: string operationType: description: The resources that are affected by the work request. enum: - ENABLE_DATA_SAFE_CONFIGURATION - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - CHANGE_PRIVATE_ENDPOINT_COMPARTMENT - CREATE_ONPREM_CONNECTOR - UPDATE_ONPREM_CONNECTOR - DELETE_ONPREM_CONNECTOR - UPDATE_ONPREM_CONNECTOR_WALLET - CHANGE_ONPREM_CONNECTOR_COMPARTMENT - CREATE_TARGET_DATABASE - UPDATE_TARGET_DATABASE - ACTIVATE_TARGET_DATABASE - DEACTIVATE_TARGET_DATABASE - UPDATE_TARGET_DATABASE_PRIVILEGE - DELETE_TARGET_DATABASE - CHANGE_TARGET_DATABASE_COMPARTMENT - REFRESH_DICTIONARY_CACHE - CREATE_PEER_TARGET_DATABASE - UPDATE_PEER_TARGET_DATABASE - DELETE_PEER_TARGET_DATABASE - REFRESH_TARGET_DATABASE - PROVISION_POLICY - RETRIEVE_POLICY - UPDATE_POLICY - CHANGE_POLICY_COMPARTMENT - CREATE_USER_ASSESSMENT - ASSESS_USER_ASSESSMENT - CREATE_SNAPSHOT_USER_ASSESSMENT - CREATE_SCHEDULE_USER_ASSESSMENT - COMPARE_WITH_BASELINE_USER_ASSESSMENT - DELETE_USER_ASSESSMENT - UPDATE_USER_ASSESSMENT - CHANGE_USER_ASSESSMENT_COMPARTMENT - SET_USER_ASSESSMENT_BASELINE - UNSET_USER_ASSESSMENT_BASELINE - GENERATE_USER_ASSESSMENT_REPORT - CREATE_SECURITY_ASSESSMENT - CREATE_SECURITY_ASSESSMENT_NOW - ASSESS_SECURITY_ASSESSMENT - CREATE_SNAPSHOT_SECURITY_ASSESSMENT - CREATE_SCHEDULE_SECURITY_ASSESSMENT - COMPARE_WITH_BASELINE_SECURITY_ASSESSMENT - DELETE_SECURITY_ASSESSMENT - UPDATE_SECURITY_ASSESSMENT - PATCH_CHECKS - UPDATE_FINDING_SEVERITY - APPLY_TEMPLATE - FLEET_GENERATE_SECURITY_ASSESSMENT_REPORT - FLEET_GENERATE_USER_ASSESSMENT_REPORT - REFRESH_TARGET_DATABASE_GROUP_WITH_CHANGES - UPDATE_FINDING_RISK - CHANGE_SECURITY_ASSESSMENT_COMPARTMENT - SET_SECURITY_ASSESSMENT_BASELINE - UNSET_SECURITY_ASSESSMENT_BASELINE - GENERATE_SECURITY_ASSESSMENT_REPORT - DELETE_SQL_FIREWALL_ALLOWED_SQL - BULK_CREATE_SQL_FIREWALL_ALLOWED_SQL - BULK_DELETE_SQL_FIREWALL_ALLOWED_SQL - CREATE_AUDIT_PROFILE - CALCULATE_VOLUME - CALCULATE_COLLECTED_VOLUME - CREATE_DB_SECURITY_CONFIG - REFRESH_DB_SECURITY_CONFIG - UPDATE_DB_SECURITY_CONFIG - CHANGE_DB_SECURITY_CONFIG_COMPARTMENT - GENERATE_FIREWALL_POLICY - UPDATE_FIREWALL_POLICY - CHANGE_FIREWALL_POLICY_COMPARTMENT - DELETE_FIREWALL_POLICY - CREATE_SQL_COLLECTION - UPDATE_SQL_COLLECTION - START_SQL_COLLECTION - STOP_SQL_COLLECTION - DELETE_SQL_COLLECTION - CHANGE_SQL_COLLECTION_COMPARTMENT - REFRESH_SQL_COLLECTION_LOG_INSIGHTS - PURGE_SQL_COLLECTION_LOGS - REFRESH_VIOLATIONS - CREATE_ARCHIVAL - CREATE_SECURITY_POLICY - DELETE_SECURITY_POLICY - SECURITY_POLICY_DEPLOYMENT_ACTIONS - PROVISION_SECURITY_POLICY_DEPLOYMENT - UPDATE_SECURITY_POLICY - CHANGE_SECURITY_POLICY_COMPARTMENT - UPDATE_SECURITY_POLICY_DEPLOYMENT - CHANGE_SECURITY_POLICY_DEPLOYMENT_COMPARTMENT - AUDIT_TRAIL - DELETE_AUDIT_TRAIL - DISCOVER_AUDIT_TRAILS - UPDATE_AUDIT_TRAIL - UPDATE_AUDIT_PROFILE - AUDIT_CHANGE_COMPARTMENT - CREATE_REPORT_DEFINITION - UPDATE_REPORT_DEFINITION - CHANGE_REPORT_DEFINITION_COMPARTMENT - DELETE_REPORT_DEFINITION - GENERATE_REPORT - GENERATE_PAGINATED_REPORT - CHANGE_REPORT_COMPARTMENT - DELETE_ARCHIVE_RETRIEVAL - CREATE_ARCHIVE_RETRIEVAL - UPDATE_ARCHIVE_RETRIEVAL - CHANGE_ARCHIVE_RETRIEVAL_COMPARTMENT - UPDATE_ALERT - TARGET_ALERT_POLICY_ASSOCIATION - CREATE_TARGET_DATABASE_GROUP - UPDATE_TARGET_DATABASE_GROUP - DELETE_TARGET_DATABASE_GROUP - CHANGE_TARGET_DATABASE_GROUP_COMPARTMENT - CREATE_SECURITY_POLICY_CONFIG - UPDATE_SECURITY_POLICY_CONFIG - DELETE_SECURITY_POLICY_CONFIG - CHANGE_SECURITY_POLICY_CONFIG_COMPARTMENT - CREATE_UNIFIED_AUDIT_POLICY - UPDATE_UNIFIED_AUDIT_POLICY - DELETE_UNIFIED_AUDIT_POLICY - CHANGE_UNIFIED_AUDIT_POLICY_COMPARTMENT - UPDATE_UNIFIED_AUDIT_POLICY_DEFINITION - DELETE_UNIFIED_AUDIT_POLICY_DEFINITION - CHANGE_UNIFIED_AUDIT_POLICY_DEFINITION_COMPARTMENT - FETCH_AUDIT_POLICY_DETAILS - BULK_CREATE_UNIFIED_AUDIT_POLICY - CREATE_SENSITIVE_DATA_MODEL - UPDATE_SENSITIVE_DATA_MODEL - DELETE_SENSITIVE_DATA_MODEL - UPLOAD_SENSITIVE_DATA_MODEL - GENERATE_SENSITIVE_DATA_MODEL_FOR_DOWNLOAD - CREATE_SENSITIVE_COLUMN - UPDATE_SENSITIVE_COLUMN - PATCH_SENSITIVE_COLUMNS - CREATE_DISCOVERY_JOB - DELETE_DISCOVERY_JOB - PATCH_DISCOVERY_JOB_RESULT - APPLY_DISCOVERY_JOB_RESULT - GENERATE_DISCOVERY_REPORT - CREATE_SENSITIVE_TYPE - UPDATE_SENSITIVE_TYPE - CREATE_MASKING_POLICY - UPDATE_MASKING_POLICY - DELETE_MASKING_POLICY - UPLOAD_MASKING_POLICY - GENERATE_MASKING_POLICY_FOR_DOWNLOAD - CREATE_MASKING_COLUMN - UPDATE_MASKING_COLUMN - PATCH_MASKING_COLUMNS - GENERATE_MASKING_REPORT - CREATE_LIBRARY_MASKING_FORMAT - UPDATE_LIBRARY_MASKING_FORMAT - ADD_COLUMNS_FROM_SDM - MASKING_JOB - CREATE_DIFFERENCE - DELETE_DIFFERENCE - UPDATE_DIFFERENCE - PATCH_DIFFERENCE - APPLY_DIFFERENCE - DELETE_MASKING_REPORT - MASK_POLICY_GENERATE_HEALTH_REPORT - MASK_POLICY_DELETE_HEALTH_REPORT - CREATE_SENSITIVE_TYPES_EXPORT - UPDATE_SENSITIVE_TYPES_EXPORT - BULK_CREATE_SENSITIVE_TYPES - CREATE_SENSITIVE_TYPE_GROUP - UPDATE_SENSITIVE_TYPE_GROUP - DELETE_SENSITIVE_TYPE_GROUP - DELETE_SENSITIVE_TYPE - PATCH_GROUPED_SENSITIVE_TYPES - CREATE_RELATION - DELETE_RELATION - ABORT_MASKING - CREATE_SECURITY_POLICY_REPORT - REFRESH_SECURITY_POLICY_CACHE - DELETE_SECURITY_POLICY_CACHE - CREATE_SCHEDULE - REMOVE_SCHEDULE_REPORT - UPDATE_ALL_ALERT - PATCH_TARGET_ALERT_POLICY_ASSOCIATION - UPDATE_TARGET_GROUP_AUDIT_PROFILE - CREATE_ATTRIBUTE_SET - UPDATE_ATTRIBUTE_SET - DELETE_ATTRIBUTE_SET - CHANGE_ATTRIBUTE_SET_COMPARTMENT - CREATE_REGISTRATION_POLICY - UPDATE_REGISTRATION_POLICY - DELETE_REGISTRATION_POLICY - CHANGE_REGISTRATION_POLICY_COMPARTMENT type: string percentComplete: description: Progress of the work request in percentage. format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - SUSPENDING - SUSPENDED type: string timeAccepted: description: 'The date and time the work request was accepted, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted type: object AuditTrail: description: 'An audit trail represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. Configuring audit trails in Data Safe, and enabling audit data collection on the audit trails copies the audit records from the target database''s audit trail into the Data Safe repository. ' properties: auditCollectionStartTime: description: The date from which the audit trail must start collecting data, in the format defined by RFC3339. format: date-time type: string auditProfileId: description: The OCID of the parent audit. maxLength: 255 minLength: 1 type: string canUpdateLastArchiveTimeOnTarget: default: true description: 'Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. ' type: boolean compartmentId: description: 'The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit trail. maxLength: 400 type: string displayName: description: The display name of the audit trail. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit trail. maxLength: 255 minLength: 1 type: string isAutoPurgeEnabled: description: 'Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database''s audit trail does not become too large. ' type: boolean lifecycleDetails: description: Details about the current state of the audit trail in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit trail. enum: - INACTIVE - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailLifecycleState' peerTargetDatabaseKey: description: The secondary id assigned for the peer database registered with Data Safe. type: integer purgeJobDetails: description: The details of the audit trail purge job that ran at the time specified by purgeJobTime". maxLength: 400 minLength: 1 type: string purgeJobStatus: description: The current status of the audit trail purge job. enum: - SUCCEEDED - FAILED type: string purgeJobTime: description: 'The date and time of the last purge job. The purge job deletes audit data in the target database every seven days so that the database''s audit trail does not become too large. In the format defined by RFC3339. ' format: date-time type: string status: description: The current sub-state of the audit trail. enum: - STARTING - COLLECTING - RECOVERING - IDLE - STOPPING - STOPPED - RESUMING - RETRYING - NOT_STARTED - STOPPED_NEEDS_ATTN - STOPPED_FAILED type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailStatus' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the Data Safe target for which the audit trail is created. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the audit trail was created, in the format defined by RFC3339. format: date-time type: string timeLastCollected: description: "The date and time until when the audit events were collected from the target database by the Data Safe audit trail \ncollection process, in the format defined by RFC3339.\n" format: date-time type: string timeUpdated: description: The date and time the audit trail was updated, in the format defined by RFC3339. format: date-time type: string trailLocation: description: 'An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. ' maxLength: 4000 type: string trailSource: description: The underlying source of unified audit trail. enum: - TABLE - FILE type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailSource' workRequestId: description: The OCID of the workrequest for audit trail which collects audit records. type: string required: - id - displayName - status - timeCreated - timeUpdated - auditProfileId - compartmentId - targetId - lifecycleState type: object SensitiveTypesExportCollection: description: A collection of sensitive types export summary objects. properties: items: description: An array of sensitive types export summary objects. items: $ref: '#/components/schemas/SensitiveTypesExportSummary' type: array required: - items type: object AlertPolicySummary: description: Summary of a Data Safe alert policy. properties: alertPolicyType: description: Indicates the Data Safe feature that the alert policy belongs to. enum: - AUDITING - SECURITY_ASSESSMENT - USER_ASSESSMENT type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyType' compartmentId: description: The OCID of the compartment that contains the alert policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The details of the alert policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the alert policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the alert policy. maxLength: 255 minLength: 1 type: string isUserDefined: description: Indicates if the alert policy is user-defined (true) or pre-defined (false). type: boolean lifecycleState: description: The current state of the alert policy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: CREATING type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyLifecycleState' severity: description: Severity level of the alert raised by this policy. enum: - CRITICAL - HIGH - MEDIUM - LOW - EVALUATE type: string x-obmcs-top-level-enum: '#/definitions/AlertSeverity' timeCreated: description: Creation date and time of the alert policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the alert policy was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - timeCreated - timeUpdated - lifecycleState - alertPolicyType type: object SecurityAssessmentSummary: description: The summary of a security assessment. properties: baselineAssessmentId: description: The OCID of the security assessment of type TEMPLATE_BASELINE. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the security assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security assessment. maxLength: 255 minLength: 1 type: string ignoredAssessmentIds: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array ignoredTargetIds: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array isBaseline: description: Indicates whether or not the assessment is a baseline assessment. This applied to saved security assessments only. type: boolean isDeviatedFromBaseline: description: Indicates whether or not the security assessment deviates from the baseline. type: boolean lastComparedBaselineId: description: The OCID of the baseline against which the latest assessment was compared. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security assessment. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security assessment. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentLifecycleState' link: description: 'The summary of findings for the security assessment. ' type: string schedule: description: 'Schedule of the assessment that runs periodically in the specified format: - ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a security assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a security assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a security assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string scheduleSecurityAssessmentId: description: The OCID of the security assessment that created this scheduled save assessment. maxLength: 255 minLength: 1 type: string statistics: $ref: '#/components/schemas/SecurityAssessmentStatistics' targetDatabaseGroupId: description: The OCID of target database group. maxLength: 255 minLength: 1 type: string targetIds: description: Array of database target OCIDs. items: maxLength: 255 minLength: 1 type: string type: array targetType: description: Indicates whether the security assessment is for a target database or a target database group. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentTargetType' templateAssessmentId: description: The OCID of the security assessment of type TEMPLATE. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the security assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeLastAssessed: description: The date and time the security assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the security assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string triggeredBy: description: Indicates whether the security assessment was created by system or by a user. enum: - USER - SYSTEM type: string type: description: 'The type of the security assessment. Possible values are: LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. SAVED: A saved security assessment. LATEST assessments are always saved in order to maintain the history of runs. A SAVED assessment is also generated by a ''refresh'' action (triggered by the user). SAVE_SCHEDULE: The schedule for periodic saves of LATEST assessments. TEMPLATE: The security assessment contains the checks that the user would like to run. It is user defined. TEMPLATE_BASELINE: The security assessment contains the checks that the user would like to run, together with the max allowed severity. The max allowed severity can be defined by the user. COMPARTMENT: An automatically managed assessment type that stores all details of targets in one compartment. This type keeps an up-to-date assessment of all database risks in one compartment. It is automatically updated when the latest assessment or refresh action is executed. It is also automatically updated when a target is deleted or move to a different compartment. ' enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT - TEMPLATE - TEMPLATE_BASELINE type: string required: - id - timeCreated - timeUpdated - lifecycleState - compartmentId - targetIds - type - displayName ChangeReportDefinitionCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object GroupedSensitiveTypeCollection: description: A collection of sensitive types summary objects present in a sensitive type group. properties: items: description: List of sensitive type id summary objects present in the sensitive type group. items: $ref: '#/components/schemas/GroupedSensitiveTypeSummary' maxItems: 1000 minItems: 0 type: array required: - items type: object CreateSensitiveTypesExportDetails: description: "Details to create a new sensitive types export. To specify some sensitive types for export, use \nsensitiveTypeIdsForExport attribute. But if you want to include all sensitive types, you can set \nisIncludeAllSensitiveTypes attributes to true. In the latter case, you do not need to list all \nsensitive types.\n" properties: compartmentId: description: The OCID of the compartment where the sensitive types export should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive types export. maxLength: 400 minLength: 1 type: string x-default-description: This field will be set to null if not provided. displayName: description: The display name of the sensitive types export. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format SensitiveTypesExport_ if not provided. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isIncludeAllSensitiveTypes: default: false description: 'Indicates if all the existing user-defined sensitive types are used for export. If it''s set to true, the sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are used. ' type: boolean sensitiveTypeIdsForExport: description: 'The OCIDs of the sensitive types used to create sensitive types export. ' items: maxLength: 255 minLength: 1 type: string maxItems: 1000 type: array required: - compartmentId type: object SqlFirewallViolationAnalyticsCollection: description: SQL violations summarized detail. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/SqlFirewallViolationAggregation' type: array required: - items type: object UpdateUnifiedAuditPolicyDetails: description: The details required to create a new unified audit policy. properties: conditions: description: Lists the audit policy provisioning conditions. items: $ref: '#/components/schemas/PolicyCondition' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the unified audit policy in Data Safe. The name is modifiable and does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object status: description: Indicates whether the policy has been enabled or disabled. type: string x-obmcs-enumref: '#/definitions/UnifiedAuditPolicy/status' type: object ReferentialRelation: description: 'A referential relation is a resource corresponding to database columns. It''s a subresource of sensitive data model resource and is always associated with a sensitive data model. ' properties: child: $ref: '#/components/schemas/ColumnsInfo' isSensitive: description: Determines if the columns present in the referential relation is present in the sensitive data model type: boolean key: description: The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the referential relation. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReferentialRelationLifecycleState' parent: $ref: '#/components/schemas/ColumnsInfo' relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sensitiveDataModelId: description: The OCID of the sensitive data model that contains the sensitive column. maxLength: 255 minLength: 1 type: string required: - key - sensitiveDataModelId - lifecycleState - relationType - parent - child type: object DatabaseTableAccessEntrySummary: description: Summary of DatabaseTableAccessEntry Object. properties: accessThroughObject: description: 'A non-null value in this field indicates the object through which user has access to table, possible values could be table or view. ' maxLength: 255 minLength: 1 type: string accessType: description: 'The type of the access the user has on the table, there can be one or more from SELECT, UPDATE, INSERT, OWNER or DELETE. ' enum: - SELECT - UPDATE - INSERT - DELETE - OWNER type: string x-obmcs-top-level-enum: '#/definitions/AccessType' areAllTablesAccessible: description: Indicates whether the user has access to all the tables in the schema. type: boolean columnName: description: If there are column level privileges on a table or view. maxLength: 255 minLength: 1 type: string grantFromRole: description: "This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the \nrole which is granted to the user though which the user has access to the table.\n" maxLength: 255 minLength: 1 type: string grantee: description: Grantee is the user who can access the table maxLength: 255 minLength: 1 type: string grantor: description: The one who granted this privilege. maxLength: 255 minLength: 1 type: string isAccessConstrainedByDatabaseVault: description: Indicates whether the table access is constrained via Oracle Database Vault. type: boolean isAccessConstrainedByLabelSecurity: description: Indicates whether the table access is constrained via Oracle Label Security. type: boolean isAccessConstrainedByRealApplicationSecurity: description: Indicates whether the table access is constrained via Real Application Security. type: boolean isAccessConstrainedByRedaction: description: Indicates whether the table access is constrained via Oracle Data Redaction. type: boolean isAccessConstrainedBySqlFirewall: description: Indicates whether the table access is constrained via Oracle Database SQL Firewall. type: boolean isAccessConstrainedByView: description: Indicates whether the access is constrained on a table via a view. type: boolean isAccessConstrainedByVirtualPrivateDatabase: description: Indicates whether the table access is constrained via Virtual Private Database. type: boolean isSensitive: description: Indicates whether the table is marked as sensitive. type: boolean key: description: The unique key that identifies the table access report. It is numeric and unique within a security policy report. maxLength: 255 minLength: 1 type: string privilege: description: Name of the privilege. enum: - SELECT - UPDATE - INSERT - DELETE - READ - OWNER - INDEX - SELECT_ANY_TABLE - UPDATE_ANY_TABLE - INSERT_ANY_TABLE - DELETE_ANY_TABLE - READ_ANY_TABLE - CREATE_ANY_INDEX type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeName' privilegeGrantable: description: "Whether grantee can grant this privilege to other users. Privileges can be granted to a user or role with \nGRANT_OPTION or ADMIN_OPTION\n" enum: - ADMIN_OPTION - GRANT_OPTION type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeGrantableOption' privilegeType: description: 'Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. ' maxLength: 400 minLength: 1 type: string tableName: description: Name of the database table the user has access to. maxLength: 255 minLength: 1 type: string tableSchema: description: Name of the schema the table belongs to. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string required: - key type: object UpdateSqlFirewallPolicyDetails: description: Details to update the SQL Firewall policy. properties: allowedClientIps: description: List of allowed ip addresses for the SQL Firewall policy. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array allowedClientOsUsernames: description: List of allowed operating system user names for the SQL Firewall policy. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array allowedClientPrograms: description: List of allowed client programs for the SQL Firewall policy. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Firewall policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL Firewall policy. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string enforcementScope: description: Specifies the SQL Firewall policy enforcement option. enum: - ENFORCE_CONTEXT - ENFORCE_SQL - ENFORCE_ALL type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object status: description: Specifies whether the SQL Firewall policy is enabled or disabled. enum: - ENABLED - DISABLED type: string violationAction: description: Specifies the SQL Firewall action based on detection of SQL Firewall violations. enum: - BLOCK - OBSERVE type: string violationAudit: description: Specifies whether a unified audit policy should be enabled for auditing the SQL Firewall policy violations. enum: - ENABLED - DISABLED type: string type: object Check: description: The security rule to be evaluated by security assessment to create finding. properties: category: description: The category to which the check belongs to. type: string key: description: A unique identifier for the check. type: string oneline: description: Provides a recommended approach to take to remediate the check reported. type: string references: $ref: '#/components/schemas/References' description: Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice. remarks: description: The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. type: string suggestedSeverity: description: The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string title: description: The short title for the check. type: string required: - key type: object UpdateSqlCollectionDetails: description: Details to update the SQL collection. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL collection. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL collection. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object UpdateSensitiveTypesExportDetails: description: Details to update a sensitive types export. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive types export. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive types export. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object SdmMaskingPolicyDifferenceCollection: description: A collection of SDM masking policy difference objects. properties: items: description: An array of SDM masking policy difference objects. items: $ref: '#/components/schemas/SdmMaskingPolicyDifferenceSummary' type: array required: - items type: object ReferentialRelationCollection: description: A collection of referential relation summary objects. properties: items: description: An array of referential relation summary objects. items: $ref: '#/components/schemas/ReferentialRelationSummary' maxItems: 500 type: array required: - items type: object GenerateHealthReportDetails: description: Details to use when performing health check on a masking policy. properties: checkType: default: ALL description: 'The type of health check. The default behaviour is to perform all health checks. ' enum: - ALL type: string compartmentId: description: The OCID of the compartment where the health report resource should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object tablespace: description: "The tablespace that should be used to estimate space.\nIf no tablespace is provided, the DEFAULT tablespace is used. \n" maxLength: 30 minLength: 1 type: string x-default-description: User's default tablespace will be used. targetCredentials: $ref: '#/components/schemas/Credentials' targetId: description: "The OCID of the target database to use for the masking policy \nhealth check. The targetId associated with the masking policy\nis used if this is not passed.\n" maxLength: 255 minLength: 1 type: string x-default-description: The targetId associated with the masking policy type: object FindingAnalyticsDimensions: description: The scope of analytics data. properties: category: description: The category of the top finding. maxLength: 100 minLength: 1 type: string key: description: 'Each finding in security assessment has an associated key (think of key as a finding''s name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings. ' maxLength: 50 minLength: 1 type: string references: $ref: '#/components/schemas/References' description: Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. remarks: description: The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. type: string severity: description: The severity (risk level) of the finding. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string title: description: The short title of the finding. maxLength: 255 minLength: 1 type: string topFindingCategory: description: The category of the top finding. maxLength: 255 minLength: 1 type: string topFindingStatus: description: "The status of the top finding. \nAll findings will have \"severity\" to indicate the risk level, but only top findings will have \"status\". \nPossible status: Pass / Risk (Low, Medium, High)/ Evaluate / Advisory / Deferred\nInstead of having \"Low, Medium, High\" in severity, \"Risk\" will include these three situations in status.\n" enum: - RISK - EVALUATE - ADVISORY - PASS - DEFERRED type: string type: object GenerateUserAssessmentReportDetails: description: The details used to generate a new user assessment report. properties: format: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string required: - format type: object SensitiveType: description: 'A sensitive type defines a particular type or class of sensitive data. It can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-types.html#GUID-45A5A3CB-5B67-4C75-9ACC-DD511D14E7C4). ' discriminator: propertyName: entityType properties: compartmentId: description: The OCID of the compartment that contains the sensitive type. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type. maxLength: 255 minLength: 1 type: string entityType: description: 'The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. ' enum: - SENSITIVE_TYPE - SENSITIVE_CATEGORY type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeEntity' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive type. maxLength: 255 minLength: 1 type: string isCommon: description: "Specifies whether the sensitive type is common. Common sensitive types belong to \nlibrary sensitive types which are frequently used to perform sensitive data discovery.\n" type: boolean lifecycleState: description: The current state of the sensitive type. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' parentCategoryId: description: The OCID of the parent sensitive category. maxLength: 255 minLength: 1 type: string shortName: description: The short name of the sensitive type. maxLength: 128 minLength: 1 type: string source: description: Specifies whether the sensitive type is user-defined or predefined. enum: - ORACLE - USER type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeSource' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the sensitive type was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive type was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - entityType - displayName - compartmentId - lifecycleState - source - timeCreated - timeUpdated type: object WorkRequestResource: description: A resource that is created or operated on by an asynchronous operation that is tracked by a work request. properties: actionType: description: 'The way in which this resource was affected by the operation that spawned the work request. A resource being created, updated, deleted, or tracked by a nested operation will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, DELETED, SUCCEEDED, FAILED, or CANCELED as appropriate. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELED type: string entityType: description: The resource type impacted by the work request. type: string entityUri: description: The URI path that the user can use for a GET request to access the resource metadata. type: string identifier: description: An OCID or other unique identifier for the resource. type: string required: - actionType - entityType - identifier type: object AuditEventAnalyticsCollection: description: Audit events summarized detail. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/AuditEventAggregationItems' type: array required: - items type: object SdmMaskingPolicyDifferenceColumnCollection: description: A collection of SDM masking policy difference column summary objects. properties: items: description: An array of SDM masking policy difference column summary objects. items: $ref: '#/components/schemas/DifferenceColumnSummary' type: array required: - items type: object UpdateSecurityAssessmentDetails: description: Updates one or more attributes of the specified security assessment. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object schedule: description: 'This is applicable only for save schedule and latest assessment. It updates the existing schedule in a specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a security assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a security assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a security assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string type: object SqlCollectionLogInsightsCollection: description: SQL collection log analytics collection. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/SqlCollectionLogAggregation' type: array required: - items type: object WorkRequestError: description: An error related to a work request. properties: code: description: 'A machine-usable error code. For a list of common errors, see [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string timestamp: description: The date and time the error occurred, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - code - message - timestamp type: object AuditProfileDimensions: description: Details of aggregation dimensions used for summarizing audit profiles. properties: isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean offlineMonthsSource: description: The name or the OCID of the resource from which the offline month retention setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string onlineMonthsSource: description: The name or the OCID of the resource from which the online month retention setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string paidUsageSource: description: The name or the OCID of the resource from which the paid usage setting is sourced. For example a target database group OCID or global. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the audit profile. maxLength: 255 minLength: 1 type: string type: object MaskDataDetails: description: Details to mask data. properties: isDecrypt: default: false description: "Indicates if the masking request is to decrypt the data values previously encrypted using Deterministic Encryption. Note that, to\ncorrectly decrypt the encrypted data values, it requires the same seed value that was provided to encrypt those data values. \n" type: boolean isDropTempTablesEnabled: description: 'Indicates if the temporary tables created during a masking operation should be dropped after masking. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. These temporary tables are dropped after masking if this attribute is set as true. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users. If it''s not provided, the value of the isDropTempTablesEnabled attribute in the MaskingPolicy resource is used. ' type: boolean isExecuteSavedScriptEnabled: default: false description: "Indicates if data masking should be performed using a saved masking script. Setting this attribute to true skips masking script\ngeneration and executes the masking script stored in the Data Safe repository. It helps save time if there are no changes in\nthe database tables and their dependencies. \n" type: boolean isIgnoreErrorsEnabled: default: true description: "Indicates if the masking process should continue on hitting an error. It provides fault tolerance support and is enabled by\ndefault. In fault-tolerant mode, the masking process saves the failed step and continues. You can then submit another masking\nrequest (with isRerun attribute set to true) to execute only the failed steps. \n" type: boolean isMoveInterimTablesEnabled: default: true description: "Indicates if the interim DMASK tables should be moved to the user-specified tablespace. As interim tables can be large in size,\nset it to false if moving them causes performance overhead during masking. \n" type: boolean isRedoLoggingEnabled: description: 'Indicates if redo logging is enabled during a masking operation. Set this attribute to true to enable redo logging. If set as false, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. If it''s not provided, the value of the isRedoLoggingEnabled attribute in the MaskingPolicy resource is used. ' type: boolean isRefreshStatsEnabled: description: 'Indicates if statistics gathering is enabled. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes. If it''s not provided, the value of the isRefreshStatsEnabled attribute in the MaskingPolicy resource is used. ' type: boolean isRerun: default: false description: "Indicates if the masking request is to rerun the previously failed masking steps. If a masking request is submitted with the\nisIgnoreErrorsEnabled attribute set to true, the masking process tracks the failed masking steps. Another masking request can be\nsubmitted with the isRun attribute set to true to rerun those failed masking steps. It helps save time by executing only the failed\nmasking steps and not doing the whole masking again. \n" type: boolean parallelDegree: description: 'Specifies options to enable parallel execution when running data masking. Allowed values are ''NONE'' (no parallelism), ''DEFAULT'' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. https://www.oracle.com/pls/topic/lookup?ctx=dblatest&en/database/oracle/oracle-database&id=VLDBG-GUID-3E2AE088-2505-465E-A8B2-AC38813EA355 If it''s not provided, the value of the parallelDegree attribute in the MaskingPolicy resource is used. ' type: string reRunFromStep: description: "Specifies the step from which masking needs to be rerun. This param will be used only when isRerun attribute is true.\nIf PRE_MASKING_SCRIPT is passed, it will rerun the pre-masking script, followed by masking, and then the post-masking script. \nIf POST_MASKING_SCRIPT is passed, it will rerun only the post-masking script.\nIf this field is not set and isRerun is set to true, then it will default to the last failed step.\n" enum: - PRE_MASKING_SCRIPT - POST_MASKING_SCRIPT type: string recompile: description: 'Specifies how to recompile invalid objects post data masking. Allowed values are ''SERIAL'' (recompile in serial), ''PARALLEL'' (recompile in parallel), ''NONE'' (do not recompile). If it''s set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes. If it''s not provided, the value of the parallelDegree attribute in the MaskingPolicy resource is used. ' type: string seed: description: The seed value to be used in case of Deterministic Encryption and Deterministic Substitution masking formats. format: password type: string x-default-description: The seed is set to null by default. tablespace: description: "The tablespace that should be used to create the mapping tables, DMASK objects, and other temporary tables for data masking.\nIf no tablespace is provided, the DEFAULT tablespace is used. \n" maxLength: 30 minLength: 1 type: string x-default-description: User's default tablespace will be used. targetCredentials: $ref: '#/components/schemas/Credentials' targetId: description: "The OCID of the target database to be masked. If it's not provided, the value of the \ntargetId attribute in the MaskingPolicy resource is used. The OCID of the target \ndatabase to be masked. If it's not provided, the value of the targetId attribute in \nthe MaskingPolicy resource is used. \n" maxLength: 255 minLength: 1 type: string x-default-description: The targetId associated with the masking policy will be used. type: object SecurityAssessmentTemplateBaselineComparison: description: 'Provides a list of the differences in a comparison of the security assessment with the template baseline value. ' properties: auditing: description: A comparison between findings belonging to Auditing category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array authorizationControl: description: A comparison between findings belonging to Authorization Control category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array dataEncryption: description: Comparison between findings belonging to Data Encryption category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array dbConfiguration: description: Comparison between findings belonging to Database Configuration category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array fineGrainedAccessControl: description: Comparison between findings belonging to Fine-Grained Access Control category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array id: description: The OCID of the security assessment that is being compared with a template baseline security assessment. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the security assessment comparison. enum: - IN_PROGRESS - SUCCEEDED - FAILED - DELETED - DELETING type: string privilegesAndRoles: description: Comparison between findings belonging to Privileges and Roles category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array templateBaselineId: description: The OCID of the security assessment that is set as a template baseline. maxLength: 255 minLength: 1 type: string templateBaselineName: description: The display name of the security assessment that is set as a template baseline. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time when the security assessment comparison was created. Conforms to the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string userAccounts: description: Comparison between findings belonging to User Accounts category. items: $ref: '#/components/schemas/TemplateBaselineDiffs' maxItems: 50 type: array required: - id - templateBaselineId - lifecycleState - timeCreated type: object SqlCollectionCollection: description: Collection of SQL collection summary. properties: items: description: Array of SQL collection summary. items: $ref: '#/components/schemas/SqlCollectionSummary' type: array required: - items type: object CreateAuditProfileDetails: description: The details used to create a new audit profile. properties: compartmentId: description: The OCID of the compartment where you want to create the audit profile. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit profile. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit profile. The name does not have to be unique, and it's updatable. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format auditprofile. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isOverrideGlobalPaidUsage: description: 'Indicates whether audit paid usage settings specified at the target database level override both the global and the target database group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see [Data Safe Price List](https://www.oracle.com/cloud/price-list/#data-safe). ' type: boolean x-default-description: Defaults to true. isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean x-default-description: Defaults to global paid usage value. offlineMonths: description: 'Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support. ' format: int32 maximum: 168 minimum: 0 type: integer x-default-description: Defaults to global offline months. onlineMonths: description: 'Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months ' format: int32 maximum: 12 minimum: 1 type: integer x-default-description: Defaults to global online months. targetId: description: The OCID of the target database or target database group for which the audit profile is created. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the audit profile. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/AuditProfileTargetType' required: - compartmentId - targetId - targetType type: object ChangeDataSafePrivateEndpointCompartmentDetails: description: The details used to change the compartment of a Data Safe private endpoint. properties: compartmentId: description: The OCID of the new compartment. maxLength: 255 minLength: 1 type: string ChangeSecurityAssessmentCompartmentDetails: description: The details that can be changed (or retained) when a security assessment is moved to another compartment. properties: compartmentId: description: 'The OCID of the compartment where you want to move the security assessment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SecurityAssessmentStatistics: description: 'Statistics showing the number of findings for each category grouped by risk levels for all the targets in the specified security assessment. The categories include Auditing, Authorization Control, Data Encryption, Database Configuration, Fine-Grained Access Control, Privileges and Roles, and User Accounts. The risk levels include High Risk, Medium Risk, Low Risk, Advisory, Evaluate, and Pass. ' properties: advisory: $ref: '#/components/schemas/SectionStatistics' deferred: $ref: '#/components/schemas/SectionStatistics' evaluate: $ref: '#/components/schemas/SectionStatistics' highRisk: $ref: '#/components/schemas/SectionStatistics' lowRisk: $ref: '#/components/schemas/SectionStatistics' mediumRisk: $ref: '#/components/schemas/SectionStatistics' pass: $ref: '#/components/schemas/SectionStatistics' targetsCount: description: The total number of targets in this security assessment. type: integer type: object MaskingErrorCollection: description: A collection of masking error objects. properties: items: description: An array of masking error objects. items: $ref: '#/components/schemas/MaskingErrorSummary' type: array required: - items type: object SensitiveDataModel: description: 'A sensitive data model is a collection of sensitive columns and their referential relationships. It helps understand the sensitive data landscape, track changes, and efficiently enable security controls such as data masking. It can be managed either manually or by performing sensitive data discovery on a reference target database. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-data-models1.html#GUID-849CA7D2-1809-40DD-B6D7-44E46EFF7EB5). ' properties: appSuiteName: description: 'The application suite name identifying a collection of applications. The default value is GENERIC. It''s useful only if maintaining a sensitive data model for a suite of applications. ' type: string compartmentId: description: The OCID of the compartment that contains the sensitive data model. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive data model. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive data model. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive data model. maxLength: 255 minLength: 1 type: string isAppDefinedRelationDiscoveryEnabled: description: 'Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It''s disabled by default and should be used only if there is a need to identify application-level relationships. ' type: boolean isIncludeAllSchemas: description: 'Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). ' type: boolean isIncludeAllSensitiveTypes: description: 'Indicates if all the existing sensitive types should be used by data discovery jobs.If it''s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. ' type: boolean isSampleDataCollectionEnabled: description: 'Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it''s disabled by default and should be used only if it''s acceptable to store sample data in Data Safe''s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. ' type: boolean lifecycleState: description: The current state of the sensitive data model. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' schemasForDiscovery: description: The schemas to be scanned by data discovery jobs. items: maxLength: 128 minLength: 1 type: string type: array sensitiveTypeGroupIdsForDiscovery: description: 'The OCIDs of the sensitive type groups to be used by data discovery jobs. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array sensitiveTypeIdsForDiscovery: description: The OCIDs of the sensitive types to be used by data discovery jobs. items: maxLength: 255 minLength: 1 type: string type: array systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tablesForDiscovery: description: "The data discovery jobs will scan the tables specified here, including both schemas and tables.\nFor instance, the input could be in the format: [{schemaName: \"HR\", tableName: [\"T1\", \"T2\"]}, {schemaName: \n\"OE\", tableName : [\"T3\", \"T4\"]}].\n" items: $ref: '#/components/schemas/TablesForDiscovery' maxItems: 1000 type: array targetId: description: 'The OCID of the reference target database associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database. ' maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the sensitive data model was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive data model was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - targetId - timeCreated - timeUpdated - lifecycleState - appSuiteName - isSampleDataCollectionEnabled - isAppDefinedRelationDiscoveryEnabled - isIncludeAllSchemas - isIncludeAllSensitiveTypes type: object SecurityAssessmentBaseLineDetails: description: The details required to set the baseline for the assessment. properties: assessmentIds: description: The list of OCIDs for the security assessments that need to be updated while setting the baseline. items: maxLength: 255 minLength: 1 type: string type: array type: object MaskingPolicyHealthReportLogCollection: description: A collection of masking policy health log objects. properties: items: description: An array of masking policy health report objects. items: $ref: '#/components/schemas/MaskingPolicyHealthReportLogSummary' type: array required: - items type: object DownloadMaskingReportDetails: description: Details to download a masking report. properties: reportFormat: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string reportId: description: The OCID of the masking report to be downloaded. maxLength: 255 minLength: 1 type: string required: - reportId - reportFormat type: object CalculateAuditVolumeCollectedDetails: description: The details for calculating audit data volume collected by data safe. properties: timeFromMonth: description: The date from which the audit volume collected by data safe has to be calculated, in the format defined by RFC3339. format: date-time type: string timeToMonth: description: The date from which the audit volume collected by data safe has to be calculated, in the format defined by RFC3339. If not specified, this will default to the current date. format: date-time type: string x-default-description: 'null' required: - timeFromMonth type: object AuditProfileCollection: description: Collection of audit profile summary. properties: items: description: Array of audit profile summary. items: $ref: '#/components/schemas/AuditProfileSummary' type: array required: - items type: object UpdateDataSafePrivateEndpointDetails: description: The details used to update the Data Safe private endpoint. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the private endpoint. maxLength: 1024 minLength: 1 type: string displayName: description: The display name of the private endpoint. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'The OCIDs of the network security groups that the private endpoint belongs to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' maxProperties: 25 type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' maxProperties: 10 type: object type: object AuditEventAggregationItems: description: The details of audit events aggregation items. properties: count: description: Total count of aggregated value. format: int64 type: integer dimensions: $ref: '#/components/schemas/AuditEventAggregationDimensions' displayName: description: Display Name of aggregation field. maxLength: 128 minLength: 0 type: string metricName: description: Name of the aggregation. maxLength: 128 minLength: 0 type: string timeEnded: description: The time at which the aggregation ended. format: date-time type: string timeStarted: description: The time at which the aggregation started. format: date-time type: string required: - metricName - timeStarted - timeEnded - count type: object AssociatedResourceSummary: description: Summary details of the associated resource of an attribute set. properties: associatedResourceId: description: The OCID of the resource that is associated with the attribute set. maxLength: 255 minLength: 1 type: string associatedResourceName: description: The display name of the resource that is associated with the attribute set. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string associatedResourceType: description: The resource type that is associated with the attribute set. enum: - AUDIT_POLICY - AUDIT_REPORT type: string timeCreated: description: The date and time when associated started between resource and the attribute set, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time when associated is removed between resources and the attribute set, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string type: object UserAssessmentComparison: description: Provides a list of differences for user assessment when compared with the baseline value. properties: lifecycleState: description: The current state of the user assessment comparison. enum: - CREATING - SUCCEEDED - FAILED type: string summary: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array timeCreated: description: The date and time the user assessment comparison was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - lifecycleState - timeCreated type: object CreateTargetDatabaseDetails: description: The details used to register the database in Data Safe and to create the Data Safe target database. properties: compartmentId: description: The OCID of the compartment in which to create the Data Safe target database. example: ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnxernheayom3pljsfppca maxLength: 100 minLength: 1 type: string connectionOption: $ref: '#/components/schemas/ConnectionOption' credentials: $ref: '#/components/schemas/Credentials' databaseDetails: $ref: '#/components/schemas/DatabaseDetails' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the target database in Data Safe. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the target database in Data Safe. The name is modifiable and does not need to be unique. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format TargetDatbase freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object peerTargetDatabaseDetails: description: The details of the database to be registered as a peer target database. items: $ref: '#/components/schemas/CreatePeerTargetDatabaseDetails' maxItems: 30 type: array tlsConfig: $ref: '#/components/schemas/TlsConfig' required: - compartmentId - databaseDetails type: object CreateSecurityPolicyDetails: description: Details to create the security policy. properties: compartmentId: description: The OCID of the compartment in which to create the security policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the security policy. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format SecurityPolicy freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object required: - compartmentId type: object UpdateSecurityPolicyConfigDetails: description: The details to update the security policy configuration. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy configuration. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string firewallConfig: $ref: '#/components/schemas/FirewallConfigDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object unifiedAuditPolicyConfig: $ref: '#/components/schemas/UnifiedAuditPolicyConfigDetails' type: object AlertsUpdateDetails: description: The details to update alerts in the specified compartment. properties: compartmentId: description: The OCID of the compartment that contains the alerts. maxLength: 100 minLength: 1 type: string status: description: The status of the alert. enum: - OPEN - CLOSED type: string x-obmcs-top-level-enum: '#/definitions/AlertStatus' targetId: description: The OCID of the target database associated with the alerts. maxLength: 255 minLength: 1 type: string required: - status - compartmentId type: object TargetAlertPolicyUnassociatedCollection: description: Collection of unassociated target alert policy association summary. properties: items: description: Array of unassociated target alert policy association summary. items: $ref: '#/components/schemas/TargetAlertPolicyUnassociatedSummary' type: array required: - items type: object AlertAnalyticsCollection: description: The summarized detail of alerts aggregation. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/AlertAggregationItems' type: array required: - items type: object SensitiveSchemaCollection: description: A collection of sensitive schema summary objects. properties: items: description: An array of sensitive schema summary objects. items: $ref: '#/components/schemas/SensitiveSchemaSummary' type: array required: - items type: object MaskingPolicyReferentialRelationSummary: description: 'A referential relation is a resource corresponding to database columns. It is always associated with a masking policy. ' properties: child: $ref: '#/components/schemas/MaskingPolicyColumnsInfo' maskingFormat: description: The masking format associated with the parent column. items: maxLength: 512 minLength: 1 type: string maxItems: 32 minItems: 1 type: array maskingPolicyId: description: The OCID of the masking policy that contains the column. maxLength: 255 minLength: 1 type: string parent: $ref: '#/components/schemas/MaskingPolicyColumnsInfo' relationType: description: 'The type of referential relationship the column has with its parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string required: - maskingPolicyId - relationType - parent - child type: object GroupMembersCollection: description: The criteria for displaying the members of a target database group. properties: targetDatabases: description: List of the OCIDs of the target databases which are members of the target database group. items: maxLength: 255 minLength: 1 type: string maxItems: 2000 minItems: 0 type: array required: - targetDatabases type: object DiscoveryJobSummary: description: Summary of a discovery job. properties: compartmentId: description: The OCID of the compartment to contain the discovery job. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object discoveryType: description: The type of discovery. type: string x-obmcs-enumref: '#/definitions/DiscoveryJob/discoveryType' displayName: description: The display name of the discovery job. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the discovery job. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' sensitiveDataModelId: description: The OCID of the sensitive data model associated with the discovery job. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database associated with the discovery job. maxLength: 255 minLength: 1 type: string timeFinished: description: The date and time the discovery job finished, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeStarted: description: The date and time the discovery job started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - timeStarted - timeFinished - sensitiveDataModelId - targetId - lifecycleState - discoveryType - compartmentId type: object UserAssessmentBaseLineDetails: description: The details required to set the baseline for the assessment. properties: assessmentIds: description: The list of OCIDs for the user assessments that need to be updated while setting the baseline. items: maxLength: 255 minLength: 1 type: string type: array type: object CompatibleFormatsForDataTypes: description: "A list of basic masking formats compatible with and grouped by the supported data types. The data types are grouped into\nthe following categories -\n Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2\n Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE\n Date - Includes DATE and TIMESTAMP\n LOB - Includes BLOB, CLOB, and NCLOB\n All - Includes all the supported data types \n" properties: formatsForDataType: description: An array of lists of basic masking formats compatible with the supported data types. items: $ref: '#/components/schemas/FormatsForDataType' type: array required: - formatsForDataType type: object SensitiveTypeCollection: description: A collection of sensitive type summary objects. properties: items: description: An array of sensitive type summary objects. items: $ref: '#/components/schemas/SensitiveTypeSummary' type: array required: - items type: object ReferentialRelationSummary: description: 'A referential relation is a resource corresponding to a database columns. It''s a subresource of sensitive data model resource and is always associated with a sensitive data model. ' properties: child: $ref: '#/components/schemas/ColumnsInfo' isSensitive: description: Determines if the columns present in the referential relation is present in the sensitive data model type: boolean key: description: The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the referential relation. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReferentialRelationLifecycleState' parent: $ref: '#/components/schemas/ColumnsInfo' relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sensitiveDataModelId: description: The OCID of the sensitive data model that contains the sensitive column. maxLength: 255 minLength: 1 type: string required: - key - sensitiveDataModelId - lifecycleState - relationType - parent - child type: object ChangeSecurityPolicyDeploymentCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the security policy deployment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PatchChecksDetails: description: Details to patch checks in a security assessment of type template. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object ChangeAuditArchiveRetrievalCompartmentDetails: description: The description of the achieve retrieval change compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the new compartment were achieve retrieval resource would move. ' example: ocid1.compartment.dev.absgk5rrqhzsicpsmrixf6n27eng7kgkuzesiswmukwarqeuedcuzdxy52wa maxLength: 100 minLength: 1 type: string required: - compartmentId type: object UpdateDatabaseSecurityConfigDetails: description: The details to update the database security config. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the database security config. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object sqlFirewallConfig: $ref: '#/components/schemas/UpdateSqlFirewallConfigDetails' type: object RoleSummary: description: The details of a role fetched from the database. properties: authenticationType: description: Type of authentication. maxLength: 128 minLength: 1 type: string isCommon: description: Is the role common. type: boolean isImplicit: description: Is the role implicit. type: boolean isInherited: description: Is the role inherited. type: boolean isOracleMaintained: description: Is the role oracle maintained. type: boolean isPasswordRequired: description: Is password required. type: boolean roleName: description: The name of the role. maxLength: 128 minLength: 1 type: string required: - roleName - authenticationType type: object DatabaseSecurityConfig: description: "Database Security Configurations resource represents the target database configurations. \nIncluded in the Database Security Configurations are the SQL Firewall configurations such as\nthe status of the firewall, the time that the firewall status was last updated, violation log auto purge settings, etc.\n" properties: compartmentId: description: The OCID of the compartment containing the database security config. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the database security config. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the database security config. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the database security config. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the database security config in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the database security config. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSecurityConfigLifecycleState' sqlFirewallConfig: $ref: '#/components/schemas/SqlFirewallConfig' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The target OCID corresponding to the database security config. maxLength: 255 minLength: 1 type: string timeCreated: description: The time that the database security config was created, in the format defined by RFC3339. format: date-time type: string timeLastRefreshed: description: The last date and time the database security config was refreshed, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the database security configuration was last updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - targetId - timeCreated - lifecycleState type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateSensitiveColumnDetails: description: Details to update a sensitive column in a sensitive data model. properties: appDefinedChildColumnKeys: description: 'Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string dbDefinedChildColumnKeys: description: 'Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array parentColumnKeys: description: 'Unique keys identifying the columns that are parents of the sensitive column. At present, it accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship. ' items: maxLength: 255 minLength: 1 type: string type: array relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sensitiveTypeId: description: The OCID of the sensitive type to be associated with the sensitive column. maxLength: 255 minLength: 1 type: string status: description: 'The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive. ' enum: - VALID - INVALID type: string type: object SensitiveDataModelSensitiveTypeCollection: description: A collection of sensitive types summary objects present in a sensitive data model. properties: items: description: An array of sensitive types summary objects present in a sensitive data model. items: $ref: '#/components/schemas/SensitiveDataModelSensitiveTypeSummary' type: array required: - items type: object ChangeUserAssessmentCompartmentDetails: description: The details used to change the compartment of the user assessment. properties: compartmentId: description: 'The OCID of the compartment where you want to move the user assessment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SensitiveTypeGroup: description: The details of the sensitive type group. properties: compartmentId: description: The OCID of the compartment that contains the sensitive type group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type group. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type group. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive type group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the sensitive type group. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeGroupLifecycleState' sensitiveTypeCount: description: The number of sensitive types in the specified sensitive type group. minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the sensitive type group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive type group was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - sensitiveTypeCount type: object SecurityFeatureAnalyticsCollection: description: The collection of database security feature analytics summary. properties: items: description: The array of database security feature analytics summary. items: $ref: '#/components/schemas/SecurityFeatureAnalyticsSummary' type: array required: - items type: object TablesForDiscovery: description: This contains the schema name along with one or more optional table names. properties: schemaName: description: This contains the name of the schema. type: string tableNames: description: This contains an optional list of the table names. items: type: string maxItems: 1000 type: array required: - schemaName type: object ProfileSummary: description: 'The summary of information about the user profiles. It includes details such as profile name, failed login attempts, sessions per user, inactive account time, password lock time, user created, target id, and the compartment id. ' properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object failedLoginAttempts: description: Maximum times the user is allowed to fail login before the user account is locked. maxLength: 128 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object inactiveAccountTime: description: 'The permitted periods of continuous inactive time during a session, expressed in minutes. Long-running queries and other operations are not subjected to this limit. ' maxLength: 128 minLength: 1 type: string isUserCreated: description: Represents if the profile is created by user. type: boolean passwordLockTime: description: Number of days the user account remains locked after failed login maxLength: 128 minLength: 1 type: string passwordVerificationFunction: description: PL/SQL that can be used for password verification. maxLength: 255 minLength: 1 type: string profileName: description: The name of the profile. maxLength: 128 minLength: 1 type: string sessionsPerUser: description: The maximum number of sessions a user is allowed to create. maxLength: 128 minLength: 1 type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string userAssessmentId: description: "The OCID of the latest user assessment corresponding to the target under consideration. A compartment \ntype assessment can also be passed to profiles from all the targets from the corresponding compartment.\n" maxLength: 255 minLength: 1 type: string userCount: description: The number of users having a given profile. format: int32 type: integer required: - userAssessmentId - compartmentId type: object DictionarySummary: description: The details of date and time when the dictionary objects were last fetched from the database. properties: timeUpdated: description: The date and time the dictionary objects were last fetched, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - timeUpdated type: object AuditEventAggregationDimensions: description: The details of the aggregation dimensions used for summarizing audit events. properties: auditEventTime: description: The time the audit event occurred in the target database. items: format: date-time type: string type: array auditPolicies: description: Comma-seperated list of audit policies that caused the current audit event. items: maxLength: 4000 minLength: 1 type: string type: array auditType: description: Type of auditing. items: enum: - STANDARD - FINE_GRAINED - XS - DATABASE_VAULT - LABEL_SECURITY - RMAN - DATAPUMP - DIRECT_PATH_API type: string type: array clientHostname: description: Name of the host machine from which the session was spawned. items: maxLength: 1024 minLength: 1 type: string type: array clientId: description: The client identifier in each Oracle session. items: maxLength: 1024 minLength: 1 type: string type: array clientIp: description: The IP address of the host from which the session was spawned. items: maxLength: 255 minLength: 1 type: string type: array clientProgram: description: The application from which the audit event was generated. For example SQL Plus or SQL Developer. items: maxLength: 512 minLength: 1 type: string type: array dbUserName: description: Name of the database user whose actions were audited. items: maxLength: 1024 minLength: 1 type: string type: array errorCode: description: The Oracle error code generated by the action. items: maxLength: 30 minLength: 1 type: string type: array eventName: description: The name of the event executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX. items: maxLength: 1024 minLength: 1 type: string type: array externalUserId: description: The user ID of the external user of the audit event. items: maxLength: 255 minLength: 1 type: string type: array objectName: description: The name of the object affected by the action. items: maxLength: 1024 minLength: 1 type: string type: array objectOwner: description: The schema name of the object affected by the action. items: maxLength: 1024 minLength: 1 type: string type: array objectType: description: Type of object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY. items: maxLength: 255 minLength: 1 type: string type: array osUserName: description: The name of the operating system user for the database session. items: maxLength: 1024 minLength: 1 type: string type: array targetClass: description: Class of the target that was audited. items: enum: - DATABASE type: string type: array targetId: description: The OCID of the target database that was audited. items: maxLength: 255 minLength: 1 type: string type: array targetName: description: The name of the target database that was audited. items: maxLength: 255 minLength: 1 type: string type: array type: object UserAccessAnalyticsSummary: description: Summary of user access analytics data properties: count: description: The total count of schemas a user can access format: int64 type: integer userName: description: Name of the user. maxLength: 255 minLength: 1 type: string required: - count - userName type: object ChangeDatabaseSecurityConfigCompartmentDetails: description: The details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the database security config. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object DownloadMaskingLogDetails: description: Details to download the masking log. properties: maskingWorkRequestId: description: The OCID of the masking work request that resulted in this masking log. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database for which the masking log is to be downloaded. maxLength: 255 minLength: 1 type: string type: object MaskingAnalyticsSummary: description: Summary of masking analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/MaskingAnalyticsDimensions' metricName: description: The name of the aggregation metric. enum: - MASKING_POLICY - MASKING_DATABASE - MASKING_WORK_REQUEST - MASKED_SENSITIVE_TYPE - MASKED_SCHEMA - MASKED_TABLE - MASKED_COLUMN - MASKED_DATA_VALUE type: string timeLastMasked: description: The date and time the target database was last masked using a masking policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - metricName - count type: object EnableDataSafeConfigurationDetails: description: The details used to enable Data Safe in the tenancy and region. properties: isEnabled: description: Indicates if Data Safe is enabled. type: boolean required: - isEnabled type: object TargetDatabase: description: The details of the Data Safe target database. properties: associatedResourceIds: description: The OCIDs of associated resources like database, Data Safe private endpoint etc. items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: The OCID of the compartment which contains the Data Safe target database. example: ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnxernheayom3pljsfppca maxLength: 100 minLength: 1 type: string connectionOption: $ref: '#/components/schemas/ConnectionOption' credentials: $ref: '#/components/schemas/Credentials' databaseDetails: $ref: '#/components/schemas/DatabaseDetails' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target database in Data Safe. maxLength: 255 minLength: 1 type: string features: description: List of enabled features based on granted ORA_DSCS_* roles in target database items: type: string type: array x-default-description: 'null' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Data Safe target database. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the target database in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the target database in Data Safe. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' peerTargetDatabases: description: The OCIDs of associated resources like database, Data Safe private endpoint, etc. items: $ref: '#/components/schemas/PeerTargetDatabase' maxItems: 30 type: array systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time of the target database registration and creation in Data Safe. format: date-time type: string timeUpdated: description: The date and time of the target database update in Data Safe. format: date-time type: string tlsConfig: $ref: '#/components/schemas/TlsConfig' required: - id - compartmentId - displayName - databaseDetails - timeCreated - lifecycleState type: object UserSummary: description: 'The summary of information about the database user. It includes details such as user type, account status, last login time, user creation time, authentication type, user profile, and time and date of the last password change and the date and time of the expiration of the password. It also contains the user category derived from these user details, as well as granted privileges. ' properties: accountStatus: description: The status of the user account. enum: - OPEN - LOCKED - EXPIRED - EXPIRED_AND_LOCKED - OPEN_AND_IN_ROLLOVER - EXPIRED_AND_IN_ROLLOVER - LOCKED_AND_IN_ROLLOVER - EXPIRED_AND_LOCKED_AND_IN_ROLLOVER - LOCKED_TIMED_AND_IN_ROLLOVER - EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL - NONE type: string adminRoles: description: The admin roles granted to the user. items: enum: - PDB_DBA - DBA - DV_ADMIN - AUDIT_ADMIN type: string type: array areAllSchemasAccessible: description: Indicates whether the user has access to all the schemas. type: boolean authenticationType: description: The user authentication method. enum: - PASSWORD - NONE type: string key: description: The unique user key. This is a system-generated identifier. Use ListUsers to get the user key for a user. maxLength: 255 minLength: 1 type: string schemaList: description: The list of database schemas current user can access. items: maxLength: 255 minLength: 1 type: string type: array targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string timeLastLogin: description: The date and time the user last logged in, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timePasswordChanged: description: The date and time the user password was last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timePasswordExpiry: description: The date and time the user's password will expire, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUserCreated: description: The date and time the user was created in the database, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string userCategory: description: The user category based on the privileges and other details of the user. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string userName: description: The database user name. maxLength: 120 minLength: 1 type: string userProfile: description: The user profile name. maxLength: 50 minLength: 1 type: string userTypes: description: 'The user type, which can be a combination of the following: ''Admin Privileged'': The user has administrative privileges. ''Application'': The user is an Oracle E-Business Suite Applications (EBS) or Fusion Applications (FA) user. ''Privileged'': The user is a privileged user. ''Schema'': The user is EXPIRED & LOCKED / EXPIRED / LOCKED, or a schema-only account (authentication type is NONE). ''Non-privileged'': The user is a non-privileged user. ' items: enum: - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED type: string type: array required: - key - userName - targetId type: object SecurityFeatureAnalyticsSummary: description: The summary of database security feature analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/SecurityFeatureAnalyticsDimensions' metricName: description: The name of the aggregation metric. enum: - SECURITY_FEATURE_STATS type: string required: - metricName - count type: object DownloadSecurityAssessmentReportDetails: description: The details used to download a security assessment report. properties: format: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string isSingleReport: default: false description: 'Optional flag controlling the output format of a target group report: - true: Return a single consolidated report file for the entire target group. - false/null (default): Return a ZIP archive containing one file per target in the group. Important: - This flag is only applicable when the security assessment OCID refers to a target group assessment (targetType TARGET_DATABASE_GROUP). - If `isSingleReport` is set to true for an individual target (targetType TARGET_DATABASE), the request will return an error. - If `isSingleReport` is null or false for an individual target, the value is ignored and the selected output format for the assessment type is returned. ' type: boolean required: - format type: object Dimensions: description: The scope of analytics data. properties: sensitiveDataModelId: description: The OCID of the sensitive data model. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string type: object MaskingAnalyticsDimensions: description: The scope of analytics data. properties: policyId: description: The OCID of the masking policy. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type masked. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string type: object SqlCollectionLogDimensions: description: The dimensions available for SQL collection analytics. properties: clientIp: description: The IP addresses for the SQL collection. maxLength: 128 minLength: 1 type: string clientOsUserName: description: The operating system user names for the SQL collection. maxLength: 512 minLength: 1 type: string clientProgram: description: The allowed client programs for the SQL collection. maxLength: 512 minLength: 1 type: string type: object CreateSdmMaskingPolicyDifferenceDetails: description: Details to create a new SDM masking policy difference. properties: compartmentId: description: The OCID of the compartment where the SDM masking policy difference resource should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object differenceType: default: ALL description: 'The type of the SDM masking policy difference. It defines the difference scope. NEW identifies new sensitive columns in the sensitive data model that are not in the masking policy. DELETED identifies columns that are present in the masking policy but have been deleted from the sensitive data model. MODIFIED identifies columns that are present in the sensitive data model as well as the masking policy but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. ' type: string x-obmcs-enumref: '#/definitions/SdmMaskingPolicyDifference/differenceType' displayName: description: A user-friendly name for the SDM masking policy difference. Does not have to be unique, and it is changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string x-default-description: SdmMaskingPolicyDifference_ freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object maskingPolicyId: description: 'The OCID of the masking policy. Note that if the masking policy is not associated with an SDM, CreateSdmMaskingPolicyDifference operation won''t be allowed. ' maxLength: 255 minLength: 1 type: string required: - maskingPolicyId - compartmentId type: object DownloadSensitiveDataModelDetails: description: Details to download a sensitive data model. properties: dataModelFormat: default: XML description: The format of the sensitive data model file. enum: - XML type: string x-obmcs-top-level-enum: '#/definitions/DataModelFormat' type: object SecurityPolicyEntryStateSummary: description: 'The resource represents the state of a specific entry type deployment on a target. ' properties: deploymentStatus: description: The current deployment status of the security policy deployment and the security policy entry associated. enum: - CREATED - MODIFIED - CONFLICT - CONNECTIVITY_ISSUE - UNSUPPORTED_SYNTAX - UNKNOWN_ERROR - UNAUTHORIZED - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyEntryStateDeploymentStatus' deploymentStatusDetails: description: Details about the current deployment status. maxLength: 400 minLength: 1 type: string entryType: description: 'The security policy entry type. Allowed values: - FIREWALL_POLICY - The SQL Firewall policy entry type. - AUDIT_POLICY - The audit policy entry type. - CONFIG - Config changes deployment. ' enum: - FIREWALL_POLICY - AUDIT_POLICY - CONFIG type: string id: description: Unique id of the security policy entry state. maxLength: 255 minLength: 1 type: string securityPolicyDeploymentId: description: The OCID of the security policy deployment associated. maxLength: 255 minLength: 1 type: string securityPolicyEntryId: description: The OCID of the security policy entry associated. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target on which the security policy is deployed. maxLength: 255 minLength: 1 type: string required: - id - securityPolicyEntryId - deploymentStatus - targetId - entryType type: object SecurityFeatureCollection: description: Collection of database security feature summary. properties: items: description: Array of database security feature summary. items: $ref: '#/components/schemas/SecurityFeatureSummary' type: array required: - items type: object UpdateSecurityPolicyDeploymentDetails: description: Details to update the security policy deployment. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy deployment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy deployment. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object UpdateAlertDetails: description: The details used to update an alert. properties: comment: description: A comment can be entered to track the alert changes done by the user. maxLength: 400 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object status: description: The status of the alert. enum: - OPEN - CLOSED type: string x-obmcs-top-level-enum: '#/definitions/AlertStatus' type: object UnifiedAuditPolicy: description: 'Resource represents a single unified audit policy on the target database. ' properties: compartmentId: description: The OCID of the compartment containing the unified audit policy. maxLength: 255 minLength: 1 type: string conditions: description: Lists the audit policy provisioning conditions. items: $ref: '#/components/schemas/PolicyCondition' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the unified audit policy. maxLength: 255 minLength: 1 type: string enabledEntities: description: Indicates on whom the audit policy is enabled. enum: - ALL_USERS - INCLUDE_USERS - INCLUDE_ROLES - EXCLUDE_USERS - INCLUDE_USERS_ROLES - DISABLED type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the unified audit policy. maxLength: 255 minLength: 1 type: string isSeeded: description: Indicates whether the unified audit policy is seeded or not. type: boolean lifecycleDetails: description: The details of the current state of the unified audit policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the unified audit policy. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION - DELETED type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the unified audit policy. maxLength: 255 minLength: 1 type: string status: description: Indicates whether the policy has been enabled or disabled. enum: - ENABLED - DISABLED type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the unified audit policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the unified audit policy was updated, in the format defined by RFC3339. format: date-time type: string unifiedAuditPolicyDefinitionId: description: The OCID of the associated unified audit policy definition. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object MaskingColumnSummary: description: Summary of a masking column. properties: childColumns: description: An array of child columns that are in referential relationship with the masking column. items: type: string type: array columnName: description: "The name of the database column. Note that the same name is used for the masking column. \nThere is no separate displayName attribute for the masking column. \n" maxLength: 128 minLength: 1 type: string dataType: description: The data type of the masking column. type: string isMaskingEnabled: description: Indicates whether data masking is enabled for the masking column. type: boolean key: description: The unique key that identifies a masking column. The key is numeric and unique within a masking policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the masking column. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the masking column. enum: - CREATING - ACTIVE - UPDATING - DELETING - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingColumnLifecycleState' maskingColumnGroup: description: "The group of the masking column. All the columns in a group are masked together to ensure \nthat the masked data across these columns continue \nto retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation. \n" maxLength: 255 minLength: 0 type: string maskingFormats: description: An array of masking formats assigned to the masking column. items: $ref: '#/components/schemas/MaskingFormat' type: array maskingPolicyId: description: The OCID of the masking policy that contains the masking column. maxLength: 255 minLength: 1 type: string objectName: description: The name of the object (table or editioning view) that contains the database column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the object that contains the database column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' schemaName: description: The name of the schema that contains the database column. maxLength: 128 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the masking column. maxLength: 255 minLength: 1 type: string timeCreated: description: "The date and time the masking column was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string timeUpdated: description: "The date and time the masking column was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string required: - key - maskingPolicyId - lifecycleState - timeCreated - timeUpdated - schemaName - objectName - columnName - isMaskingEnabled type: object MaskingPolicy: description: "A masking policy defines the approach to mask data in a target database. It's basically \na collection of columns to be masked, called masking columns, and the associated masking \nformats to be used to mask these columns. A masking policy can be used to mask multiple \ndatabases provided that they have the same schema design. For more information, see \nMasking Policies \nin the Oracle Data Safe documentation. \n" properties: areTargetCredentialsRequired: description: Specifies whether target database credentials are required to perform masking with this policy type: boolean columnSource: $ref: '#/components/schemas/ColumnSourceDetails' compartmentId: description: The OCID of the compartment that contains the masking policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the masking policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the masking policy. maxLength: 255 minLength: 1 type: string isDropTempTablesEnabled: description: "Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default.\nSet this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive \ndata values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want \nto preserve this information to track how masking changed your data. Note that doing so compromises security. These tables \nmust be dropped before the database is available for unprivileged users. \n" type: boolean isRedoLoggingEnabled: description: "Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to\nenable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked \ndata from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking,\nyou could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. \n" type: boolean isRefreshStatsEnabled: description: 'Indicates if statistics gathering is enabled. It''s enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes. ' type: boolean lifecycleState: description: The current state of the masking policy. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' parallelDegree: description: 'Specifies options to enable parallel execution when running data masking. Allowed values are ''NONE'' (no parallelism), ''DEFAULT'' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. ' type: string postMaskingScript: description: 'A post-masking script, which can contain SQL and PL/SQL statements. It''s executed after the core masking script generated using the masking policy. It''s usually used to perform additional transformation or cleanup work after masking. ' type: string preMaskingScript: description: "A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before \nthe core masking script generated using the masking policy. It's usually used to perform\nany preparation or prerequisite work before masking data.\n" type: string recompile: description: "Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), \n'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree\nattribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.\n" enum: - SERIAL - PARALLEL - NONE type: string timeCreated: description: "The date and time the masking policy was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string timeUpdated: description: "The date and time the masking policy was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) \n" format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - timeUpdated - isDropTempTablesEnabled - isRedoLoggingEnabled - isRefreshStatsEnabled - parallelDegree - recompile type: object AuditProfile: description: The resource represents audit profile settings and audit configurations for the database target, and helps evaluate the initial audit data volume for configuring collection in Data Safe. The resource is also responsible for auto-discovery of audit trails in the database target during target's registration. properties: auditCollectedVolume: description: "Number of audit records collected in the current calendar month. \nAudit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.\n" format: int64 type: integer auditTrails: description: Contains the list of available audit trails on the target database. items: $ref: '#/components/schemas/AuditTrail' type: array compartmentId: description: The OCID of the compartment that contains the audit profile. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit profile. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit profile. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit profile. maxLength: 255 minLength: 1 type: string isOverrideGlobalPaidUsage: description: 'Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see [Data Safe Price List](https://www.oracle.com/cloud/price-list/#data-safe). ' type: boolean isOverrideGlobalRetentionSetting: description: "Indicates whether audit retention settings like online and offline months set at the \ntarget level override both the global settings and the target group level audit retention settings.\n" type: boolean isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean lifecycleDetails: description: Details about the current state of the audit profile in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit profile. enum: - CREATING - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION - DELETED type: string x-obmcs-top-level-enum: '#/definitions/AuditProfileLifecycleState' offlineMonths: description: 'Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support. ' format: int32 minimum: 0 type: integer offlineMonthsSource: description: The name or the OCID of the resource from which the offline month retention setting is sourced. For example, a global setting or a target database group OCID. maxLength: 255 minLength: 1 type: string onlineMonths: description: "Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. \nMinimum: 1; Maximum: 12 months\n" format: int32 maximum: 12 minimum: 1 type: integer onlineMonthsSource: description: The name or the OCID of the resource from which the online month retention setting is sourced. For example, a global setting or a target database group OCID. maxLength: 255 minLength: 1 type: string paidUsageSource: description: The name or the OCID of the resource from which the paid usage setting is sourced. For example, a global setting or a target database group OCID. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target database or target database group for which the audit profile is created. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the audit profile. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/AuditProfileTargetType' timeCreated: description: The date and time the audit profile was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the audit profile was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated - targetId - isPaidUsageEnabled - onlineMonths - offlineMonths - isOverrideGlobalRetentionSetting type: object AvailableAuditVolumeCollection: description: Collection of available audit volume summary. properties: items: description: Array of available audit volume summary. items: $ref: '#/components/schemas/AvailableAuditVolumeSummary' type: array required: - items type: object ActivateTargetDatabaseDetails: description: The details required to reactivate a previously deactived target database in Data Safe. properties: credentials: $ref: '#/components/schemas/Credentials' type: object SqlFirewallPolicySummary: description: 'The SQL Firewall policy resource contains the firewall policy metadata for a single user. ' properties: compartmentId: description: The OCID of the compartment containing the SQL Firewall policy. maxLength: 100 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Firewall policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL Firewall policy. maxLength: 255 minLength: 1 type: string enforcementScope: description: Specifies the SQL Firewall policy enforcement option. enum: - ENFORCE_CONTEXT - ENFORCE_SQL - ENFORCE_ALL type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL Firewall policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the SQL Firewall policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the SQL Firewall policy. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallPolicyLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the SQL Firewall policy. maxLength: 255 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string status: description: Specifies whether the SQL Firewall policy is enabled or disabled. enum: - ENABLED - DISABLED type: string timeCreated: description: The time that the SQL Firewall policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the SQL Firewall policy was last updated, in the format defined by RFC3339. format: date-time type: string violationAction: description: Specifies the SQL Firewall action based on detection of SQL Firewall violations. enum: - BLOCK - OBSERVE type: string violationAudit: description: Specifies whether a unified audit policy should be enabled for auditing the SQL Firewall policy violations. enum: - ENABLED - DISABLED type: string required: - id - displayName - compartmentId - securityPolicyId - dbUserName - status - timeCreated - lifecycleState type: object DownloadSensitiveTypesExportDetails: description: Details to download a sensitive types export. properties: dataModelFormat: default: XML description: The format of the sensitive types export file. enum: - XML type: string x-obmcs-top-level-enum: '#/definitions/DataModelFormat' type: object LibraryMaskingFormatCollection: description: A collection of library masking format summary objects. properties: items: description: An array of library masking format summary objects. items: $ref: '#/components/schemas/LibraryMaskingFormatSummary' type: array required: - items type: object DownloadMaskingPolicyDetails: description: Details to download a masking policy. properties: policyFormat: default: XML description: The format of the masking policy file. enum: - XML type: string x-obmcs-top-level-enum: '#/definitions/PolicyFormat' type: object UpdateSqlFirewallConfigDetails: description: 'Details to update the SQL Firewall config. ' properties: excludeJob: description: Specifies whether the firewall should include or exclude the database internal job activities. enum: - EXCLUDED - INCLUDED type: string status: description: Specifies whether the firewall is enabled or disabled on the target database. enum: - ENABLED - DISABLED type: string violationLogAutoPurge: description: "Specifies whether Data Safe should automatically purge the violation logs \nfrom the database after collecting the violation logs and persisting on Data Safe.\n" enum: - ENABLED - DISABLED type: string type: object UpdateFindingDetails: description: Details to update a finding in a security assessment. properties: justification: description: User provided reason for accepting or modifying this finding if they choose to do so. maxLength: 4000 minLength: 1 type: string severity: description: The severity of the finding as defined or changed by the user. type: string x-obmcs-enumref: '#/definitions/Finding/severity' timeValidUntil: description: The time until which the change in severity (deferred / modified) got the given finding is valid. format: date-time type: string type: object DatabaseTableAccessEntry: description: 'A DatabaseTableAccess is a resource corresponding to a row in database table access report. It contains information about user''s privilege grants that enable table access for the user. It''s a subresource of Security Policy Report resource and is always associated with a SecurityPolicyReport. ' properties: accessThroughObject: description: 'A non-null value in this field indicates the object through which user has access to table, possible values could be table or view. ' maxLength: 255 minLength: 1 type: string accessType: description: 'The type of the access the user has on the table, there can be one or more from SELECT, UPDATE, INSERT, OWNER or DELETE. ' enum: - SELECT - UPDATE - INSERT - DELETE - OWNER type: string x-obmcs-top-level-enum: '#/definitions/AccessType' areAllTablesAccessible: description: Indicates whether the user has access to all the tables in the schema. type: boolean columnName: description: If there are column level privileges on a table or view. maxLength: 255 minLength: 1 type: string grantFromRole: description: "This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the \nrole which is granted to the user though which the user has access to the table.\n" maxLength: 255 minLength: 1 type: string grantee: description: Grantee is the user who can access the table maxLength: 255 minLength: 1 type: string grantor: description: The one who granted this privilege. maxLength: 255 minLength: 1 type: string isAccessConstrainedByDatabaseVault: description: Indicates whether the table access is constrained via Oracle Database Vault. type: boolean isAccessConstrainedByLabelSecurity: description: Indicates whether the table access is constrained via Oracle Label Security. type: boolean isAccessConstrainedByRealApplicationSecurity: description: Indicates whether the table access is constrained via Real Application Security. type: boolean isAccessConstrainedByRedaction: description: Indicates whether the table access is constrained via Oracle Data Redaction. type: boolean isAccessConstrainedBySqlFirewall: description: Indicates whether the table access is constrained via Oracle Database SQL Firewall. type: boolean isAccessConstrainedByView: description: Indicates whether the access is constrained on a table via a view. type: boolean isAccessConstrainedByVirtualPrivateDatabase: description: Indicates whether the table access is constrained via Virtual Private Database. type: boolean isSensitive: description: Indicates whether the table is marked as sensitive. type: boolean key: description: The unique key that identifies the table access report. It is numeric and unique within a security policy report. maxLength: 255 minLength: 1 type: string privilege: description: Name of the privilege. enum: - SELECT - UPDATE - INSERT - DELETE - READ - OWNER - INDEX - SELECT_ANY_TABLE - UPDATE_ANY_TABLE - INSERT_ANY_TABLE - DELETE_ANY_TABLE - READ_ANY_TABLE - CREATE_ANY_INDEX type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeName' privilegeGrantable: description: "Indicates whether the grantee can grant this privilege to other users. Privileges can be granted to a user or role with \nGRANT_OPTION or ADMIN_OPTION\n" enum: - ADMIN_OPTION - GRANT_OPTION type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeGrantableOption' privilegeType: description: 'Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. ' maxLength: 400 minLength: 1 type: string tableName: description: The name of the database table the user has access to. maxLength: 255 minLength: 1 type: string tableSchema: description: The name of the schema the table belongs to. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string required: - key type: object AttributeSet: description: 'Represents an attribute set. An attribute set is a collection of data attributes defined by the user. i.e an attribute set of ip addresses, os user names or database privileged users. ' properties: attributeSetType: description: The type of attribute set. enum: - IP_ADDRESS - CLIENT_PROGRAM - OS_USER - DATABASE_USER - DATABASE_OBJECT type: string attributeSetValues: description: The list of values in an attribute set items: maxLength: 256 minLength: 1 type: string maxItems: 1000 type: array compartmentId: description: The OCID of the compartment where the attribute set is stored. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of an attribute set. maxLength: 400 minLength: 1 type: string displayName: description: The display name of an attribute set. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of an attribute set. maxLength: 255 minLength: 1 type: string inUse: description: Indicates whether the attribute set is in use by other resource. enum: - 'YES' - 'NO' type: string isUserDefined: description: A boolean flag indicating to list user defined or seeded attribute sets. type: boolean lifecycleState: description: The current state of an attribute set. enum: - CREATING - ACTIVE - FAILED - DELETING - UPDATING type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time an attribute set was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time an attribute set was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - attributeSetType - attributeSetValues - lifecycleState - timeCreated type: object Compartments: description: Containing the OCID of the compartment and a boolean value to indicates compartmentIdInSubtree. properties: id: description: The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group. maxLength: 255 minLength: 1 type: string isIncludeSubtree: default: false description: This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false. type: boolean required: - id SensitiveTypeGroupCollection: description: A collection of sensitive type group summary objects. properties: items: description: An array of sensitive type group summary objects. items: $ref: '#/components/schemas/SensitiveTypeGroupSummary' maxItems: 1000 type: array required: - items type: object ColumnsInfo: description: columnsInfo object has details of column group with schema details. properties: appName: description: The application name. maxLength: 128 minLength: 1 type: string columnGroup: description: 'Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. ' items: maxLength: 128 minLength: 1 type: string maxItems: 32 minItems: 1 type: array objectName: description: The database object that contains the columns. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string schemaName: description: The schema name. maxLength: 128 minLength: 1 type: string sensitiveTypeIds: description: "Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group.\nFor the DB defined referential relations identified during SDM creation, we cannot add sensitive types. \nInstead use the sensitiveColumn POST API to mark the columns sensitive.\n" items: maxLength: 255 minLength: 1 type: string maxItems: 32 minItems: 1 type: array required: - schemaName - objectType - objectName - appName - columnGroup type: object SensitiveTypeSummary: description: Summary of a sensitive type. properties: compartmentId: description: The OCID of the compartment that contains the sensitive type. maxLength: 100 minLength: 1 type: string defaultMaskingFormatId: description: The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type. maxLength: 255 minLength: 1 type: string entityType: description: 'The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. ' enum: - SENSITIVE_TYPE - SENSITIVE_CATEGORY type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeEntity' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive type. maxLength: 255 minLength: 1 type: string isCommon: description: "Specifies whether the sensitive type is common. Common sensitive types belong to \nlibrary sensitive types which are frequently used to perform sensitive data discovery.\n" type: boolean lifecycleState: description: The current state of the sensitive type. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' parentCategoryId: description: The OCID of the parent sensitive category. maxLength: 255 minLength: 1 type: string shortName: description: The short name of the sensitive type. maxLength: 128 minLength: 1 type: string source: description: Specifies whether the sensitive type is user-defined or predefined. enum: - ORACLE - USER type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeSource' timeCreated: description: The date and time the sensitive type was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive type was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - source - timeCreated - timeUpdated - entityType type: object RoleGrantPathSummary: description: The summary of user role grant paths. properties: depthLevel: description: 'The grant depth level of the indirect grant. An indirectly granted role/privilege is granted to the user through another role. The depth level indicates how deep a privilege is within the grant hierarchy. ' format: int32 type: integer grantedRole: description: The name of the role. maxLength: 255 minLength: 1 type: string grantee: description: Grantee is the user who can access the table. maxLength: 255 minLength: 1 type: string key: description: The unique key of a role grant. maxLength: 255 minLength: 1 type: string required: - key type: object CompareToTemplateBaselineDetails: description: Details specifying the security assessment used for comparison. properties: comparisonSecurityAssessmentId: description: 'The OCID of the security assessment. In this case a security assessment needs to be a template baseline assessment. ' maxLength: 255 minLength: 1 type: string required: - comparisonSecurityAssessmentId type: object UnifiedAuditPolicyCollection: description: Collection of audit policy summaries. properties: items: description: Array of audit policy summaries. items: $ref: '#/components/schemas/UnifiedAuditPolicySummary' type: array required: - items type: object AlertSummary: description: Summary of a Data Safe Alert. properties: alertType: description: Type of the alert. Indicates the Data Safe feature triggering the alert. enum: - AUDITING - SECURITY_ASSESSMENT - USER_ASSESSMENT type: string x-obmcs-top-level-enum: '#/definitions/AlertType' compartmentId: description: The OCID of the compartment that contains the alert. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The details of the alert. maxLength: 400 type: string displayName: description: The display name of the alert. maxLength: 255 minLength: 1 type: string featureDetails: additionalProperties: additionalProperties: description: 'Value of the map as key-pair values. Example: `{"critical": "users"}` ' type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object description: "Map that contains maps of values.\n Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n" type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the alert. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the alert. enum: - UPDATING - SUCCEEDED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AlertLifecycleState' operation: description: The operation that triggered alert. maxLength: 100 minLength: 1 type: string operationStatus: description: The result of the operation (event) that triggered alert. enum: - SUCCEEDED - FAILED type: string operationTime: description: Creation date and time of the operation that triggered alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string policyId: description: The OCID of the policy that triggered alert. maxLength: 255 minLength: 1 type: string severity: description: Severity level of the alert. enum: - CRITICAL - HIGH - MEDIUM - LOW - EVALUATE type: string x-obmcs-top-level-enum: '#/definitions/AlertSeverity' status: description: The status of the alert. enum: - OPEN - CLOSED type: string x-obmcs-top-level-enum: '#/definitions/AlertStatus' targetIds: description: Array of OCIDs of the target database. items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true targetNames: description: Array of names of the target database. items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: false timeCreated: description: Creation date and time of the alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the alert was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - timeCreated - timeUpdated - lifecycleState - status - severity type: object ColumnSummary: description: The details of a column in a table fetched from the database. properties: characterLength: description: Character length. type: integer x-default-description: 'null' columnName: description: Name of the column. maxLength: 128 minLength: 1 type: string dataType: description: Data type of the column. maxLength: 128 minLength: 1 type: string length: description: Length of the data represented by the column. format: int64 type: integer precision: description: Precision of the column. type: integer x-default-description: 'null' scale: description: Scale of the column. type: integer x-default-description: 'null' schemaName: description: Name of the schema. maxLength: 128 minLength: 1 type: string tableName: description: Name of the table. maxLength: 128 minLength: 1 type: string required: - columnName - dataType - length - tableName - schemaName type: object GlobalSettings: description: 'Details of the tenancy level global settings in Data Safe. ' properties: isPaidUsage: default: false description: The paid usage option chosen by the customer admin. type: boolean offlineRetentionPeriod: default: 12 description: The offline retention period in months. type: integer onlineRetentionPeriod: default: 12 description: The online retention period in months. type: integer type: object FormatEntry: description: "A format entry is part of a masking format and defines the logic to mask data. A format \nentry can be a basic masking format such as Random Number, or it can be a library masking \nformat. If a masking format has more than one format entries, the combined output of all \nthe format entries is used for masking. \n" discriminator: propertyName: type properties: description: description: The description of the format entry. maxLength: 400 minLength: 1 type: string type: description: The type of the format entry. enum: - DELETE_ROWS - DETERMINISTIC_SUBSTITUTION - DETERMINISTIC_ENCRYPTION - DETERMINISTIC_ENCRYPTION_DATE - FIXED_NUMBER - FIXED_STRING - LIBRARY_MASKING_FORMAT - NULL_VALUE - PATTERN - POST_PROCESSING_FUNCTION - PRESERVE_ORIGINAL_DATA - RANDOM_DATE - RANDOM_DECIMAL_NUMBER - RANDOM_DIGITS - RANDOM_LIST - RANDOM_NUMBER - RANDOM_STRING - RANDOM_SUBSTITUTION - REGULAR_EXPRESSION - SHUFFLE - SQL_EXPRESSION - SUBSTRING - TRUNCATE_TABLE - USER_DEFINED_FUNCTION type: string x-obmcs-top-level-enum: '#/definitions/FormatEntryType' required: - type type: object UpdateRegistrationPolicyDetails: description: 'The details required to update an existing registration policy. This object contains the necessary information to update a registration policy, including the display name, features, and OnPrem connection IDs ' properties: canOverrideFeatures: description: Indicates whether features will be overridden for all targets. type: boolean connectionOption: $ref: '#/components/schemas/PolicyConnectionOption' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the registration policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the registration policy. maxLength: 255 minLength: 1 type: string features: description: The Data Safe features granted to the databases registering under the registration policy. items: enum: - ASSESSMENT - AUDIT_COLLECTION - AUDIT_SETTING - DATA_DISCOVERY - MASKING - SQL_FIREWALL - ALL type: string x-obmcs-top-level-enum: '#/definitions/RegistrationPolicyFeatures' type: array uniqueItems: true freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object MaskingPolicyHealthReportLogSummary: description: A log entry related to the pre-masking health check. properties: description: description: A human-readable description for the log entry. type: string healthCheckType: description: "An enum type entry for each health check in the masking policy. Each enum describes a type of health check.\nINVALID_OBJECT_CHECK checks if there exist any invalid objects in the masking tables.\nPRIVILEGE_CHECK checks if the masking user has sufficient privilege to run masking.\nTABLESPACE_CHECK checks if the user has sufficient default and TEMP tablespace. Also verifies that the specified tablespace by the user is valid, if user has provided one\nDATABASE_OR_SYSTEM_TRIGGERS_CHECK checks if there exist any database/system triggers available.\nUNDO_TABLESPACE_CHECK checks if for all the instances of undo tablespace the AUTOEXTEND feature is enabled. \nIf it's not enabled, it further checks if the undo tablespace has any space remaining.\nSTATE_STATS_CHECK checks if all the statistics of the masking table is upto date or not.\nOLS_POLICY_CHECK , VPD_POLICY_CHECK and REDACTION_POLICY_CHECK checks if the masking tables has Oracle Label Security (OLS) or Virtual Private Database (VPD) or Redaction policies enabled.\nDV_ENABLE_CHECK checks if database has Database Vault(DV) enabled\nDE_COL_SIZE_CHECK checks if any masking column with DETERMINISTIC ENCRYPTION as masking format has average column size greater than 27 or not.\nACTIVE_MASK_JOB_CHECK checks if there is any active masking job running on the target database.\nDETERMINISTIC_ENCRYPTION_FORMAT_CHECK checks if any masking column has deterministic encryption masking format.\nCOLUMN_EXIST_CHECK checks if the masking columns are available in the target database.\nTIME_TRAVEL_CHECK checks if the masking tables have Time Travel enabled.\nSYSTEM_OBJECTS_CHECK checks if the masking tables have dependent objects present in SYS schema.\nINVALID_PACKAGE_CHECK checks if any of the required packages are in invalid state.\nAUDIT_POLICY_CHECK checks if the masking tables have Audit policies enabled.\nUSER_CREDENTIALS_CHECK checks if target database user credentials are required to run masking using the policy\n" enum: - INVALID_OBJECT_CHECK - PRIVILEGE_CHECK - TABLESPACE_CHECK - DATABASE_OR_SYSTEM_TRIGGERS_CHECK - UNDO_TABLESPACE_CHECK - STATE_STATS_CHECK - OLS_POLICY_CHECK - VPD_POLICY_CHECK - DV_ENABLE_CHECK - DE_COL_SIZE_CHECK - REDACTION_POLICY_CHECK - ACTIVE_MASK_JOB_CHECK - TARGET_VALIDATION_CHECK - DETERMINISTIC_ENCRYPTION_FORMAT_CHECK - COLUMN_EXIST_CHECK - TIME_TRAVEL_CHECK - SYSTEM_OBJECTS_CHECK - INVALID_PACKAGE_CHECK - AUDIT_POLICY_CHECK - USER_CREDENTIALS_CHECK type: string message: description: A human-readable log entry. type: string messageType: description: The log entry type. enum: - PASS - WARNING - ERROR type: string remediation: description: A human-readable log entry to remedy any error or warnings in the masking policy. type: string timestamp: description: 'The date and time the log entry was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - messageType - timestamp - description type: object MaskingColumn: description: "A masking column is a resource corresponding to a database column that you want to \nmask. It's a subresource of masking policy resource and is always associated with \na masking policy. Note that only parent columns are managed as masking columns. \nThe child columns are automatically managed using the childColumns attribute. \n" properties: childColumns: description: An array of child columns that are in referential relationship with the masking column. items: type: string type: array columnName: description: "The name of the database column. Note that the same name is used for the masking column. \nThere is no separate displayName attribute for the masking column. \n" maxLength: 128 minLength: 1 type: string dataType: description: The data type of the masking column. type: string isMaskingEnabled: description: Indicates whether data masking is enabled for the masking column. type: boolean key: description: The unique key that identifies the masking column. It's numeric and unique within a masking policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the masking column. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the masking column. enum: - CREATING - ACTIVE - UPDATING - DELETING - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingColumnLifecycleState' maskingColumnGroup: description: "The group of the masking column. All the columns in a group are masked together to ensure \nthat the masked data across these columns continue to retain the same logical relationship. \nFor more details, check Group Masking in the Data Safe documentation. \n" maxLength: 255 minLength: 0 type: string maskingFormats: description: An array of masking formats assigned to the masking column. items: $ref: '#/components/schemas/MaskingFormat' type: array maskingPolicyId: description: The OCID of the masking policy that contains the masking column. maxLength: 255 minLength: 1 type: string objectName: description: The name of the object (table or editioning view) that contains the database column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the object that contains the database column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' schemaName: description: The name of the schema that contains the database column. maxLength: 128 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the masking column. maxLength: 255 minLength: 1 type: string timeCreated: description: "The date and time the masking column was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string timeUpdated: description: "The date and time the masking column was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string required: - key - maskingPolicyId - lifecycleState - timeCreated - timeUpdated - schemaName - objectName - columnName - isMaskingEnabled type: object PatchFindingsDetails: description: Details to patch findings in a security assessment of type template baseline. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object References: description: References to the sections of STIG, CIS, GDPR and/or ORP relevant to the current finding. properties: cis: description: Relevant section from CIS. type: string gdpr: description: Relevant section from GDPR. type: string obp: description: Relevant section from OBP. type: string orp: description: Relevant section from ORP. type: string stig: description: Relevant section from STIG. type: string ConnectionOption: description: Types of connection supported by Data Safe. discriminator: propertyName: connectionType properties: connectionType: description: 'The connection type used to connect to the database. Allowed values: - PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. - ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe. ' enum: - PRIVATE_ENDPOINT - ONPREM_CONNECTOR type: string required: - connectionType type: object DataSafePrivateEndpointSummary: description: Summary of a Data Safe private endpoint. properties: compartmentId: description: The OCID of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the private endpoint. type: string displayName: description: The display name of the private endpoint. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Data Safe private endpoint. type: string lifecycleState: description: The current state of the private endpoint. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NA type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' privateEndpointId: description: The OCID of the private endpoint. type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' maxProperties: 25 type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' maxProperties: 10 type: object subnetId: description: The OCID of the subnet. type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string vcnId: description: The OCID of the VCN. type: string required: - id - displayName - compartmentId - vcnId - subnetId - privateEndpointId type: object AuditArchiveRetrieval: description: 'Represents the archive retrieve request for the audit data. You can retrieve audit data for a target database from the archive and store it online. For more information, see [Retrieve Audit Data for a Target Database from the Archive](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/security-assessment-overview.html). ' properties: auditEventCount: description: Total count of audit events to be retrieved from the archive for the specified date range. format: int64 type: integer compartmentId: description: The OCID of the compartment that contains archive retrieval. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the archive retrieval. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the archive retrieval. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string endDate: description: End month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string errorInfo: description: The Error details of a failed archive retrieval. maxLength: 512 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the archive retrieval. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the archive retrieval. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the archive retrieval. enum: - CREATING - ACTIVE - NEEDS_ATTENTION - FAILED - DELETING - DELETED - UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AuditArchiveRetrievalLifecycleState' startDate: description: Start month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target associated with the archive retrieval. maxLength: 255 minLength: 1 type: string timeCompleted: description: The date time when archive retrieval request was fulfilled, in the format defined by RFC3339. format: date-time type: string timeOfExpiry: description: The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival. format: date-time type: string timeRequested: description: The date time when archive retrieval was requested, in the format defined by RFC3339. format: date-time type: string required: - id - compartmentId - displayName - startDate - endDate - targetId - lifecycleState type: object CreateReportDefinitionDetails: description: Description of a new report definition. properties: columnFilters: description: An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden. items: $ref: '#/components/schemas/columnFilter' type: array columnInfo: description: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user). items: $ref: '#/components/schemas/column' type: array columnSortings: description: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc. items: $ref: '#/components/schemas/columnSorting' type: array compartmentId: description: The OCID of the compartment containing the report definition. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the report definition. maxLength: 400 minLength: 1 type: string displayName: description: Specifies the name of the report definition. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object parentId: description: The OCID of the parent report definition. maxLength: 255 minLength: 1 type: string summary: description: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user). items: $ref: '#/components/schemas/summary' type: array required: - displayName - columnInfo - columnFilters - columnSortings - summary - compartmentId - parentId type: object FormatsForSensitiveType: description: A list of library masking formats compatible with an existing sensitive type. properties: maskingFormats: description: An array of the library masking formats compatible with the sensitive type. items: $ref: '#/components/schemas/FormatSummary' maxItems: 100 minItems: 1 type: array sensitiveTypeId: description: The OCID of the sensitive type. type: string required: - sensitiveTypeId type: object UnifiedAuditPolicyDefinitionSummary: description: 'Resource represents a single unified audit policy definition. ' properties: auditPolicyCategory: description: The category to which the unified audit policy belongs. type: string x-obmcs-enumref: '#/definitions/UnifiedAuditPolicyDefinition/auditPolicyCategory' compartmentId: description: The OCID of the compartment containing the unified audit policy definition. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy definition. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the unified audit policy definition. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the unified audit policy definition. maxLength: 255 minLength: 1 type: string isSeeded: description: Signifies whether the unified audit policy definition is seeded or not. type: boolean lifecycleDetails: description: Details about the current state of the unified audit policy definition. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the unified audit policy definition. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyDefinitionLifecycleState' policyDefinitionStatement: description: The unified audit policy definition that will be provisioned in the target database. maxLength: 32767 minLength: 1 type: string policyName: description: The unified audit policy name in the target database. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the unified audit policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the unified audit policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object Profile: description: 'The comprehensive information about the user profiles available on a given target. It includes details such as profile name, failed login attempts, password reuse time, password verification function, password verification function implementation code snippet, sessions per user, connect time inactive account time, password lock time, cpu usage per session, target id, and compartment id. ' properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string compositeLimit: description: 'Specify the total resource cost for a session, expressed in service units. Oracle Database calculates the total service units as a weighted sum of CPU_PER_SESSION, CONNECT_TIME, LOGICAL_READS_PER_SESSION, and PRIVATE_SGA. ' maxLength: 128 minLength: 1 type: string connectTime: description: Specify the total elapsed time limit for a session, expressed in minutes. maxLength: 128 minLength: 1 type: string cpuPerCall: description: Specify the CPU time limit for a call (a parse, execute, or fetch), expressed in hundredths of seconds. maxLength: 128 minLength: 1 type: string cpuPerSession: description: Specify the CPU time limit for a session, expressed in hundredth of seconds. maxLength: 128 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object failedLoginAttempts: description: Maximum times the user is allowed in fail login before the user account is locked. maxLength: 128 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object idleTime: description: Specify the permitted periods of continuous inactive time during a session, expressed in minutes. maxLength: 128 minLength: 1 type: string inactiveAccountTime: description: 'The permitted periods of continuous inactive time during a session, expressed in minutes. Long-running queries and other operations are not subject to this limit. ' maxLength: 128 minLength: 1 type: string isUserCreated: description: Represents if the profile is created by user. type: boolean logicalReadsPerCall: description: Specify the permitted the number of data blocks read for a call to process a SQL statement (a parse, execute, or fetch). maxLength: 128 minLength: 1 type: string logicalReadsPerSession: description: Specify the permitted number of data blocks read in a session, including blocks read from memory and disk. maxLength: 128 minLength: 1 type: string passwordGraceTime: description: Number of grace days for user to change password. maxLength: 128 minLength: 1 type: string passwordLifeTime: description: Number of days the password is valid before expiry. maxLength: 128 minLength: 1 type: string passwordLockTime: description: Number of days the user account remains locked after failed login. maxLength: 128 minLength: 1 type: string passwordReuseMax: description: Number of day after the user can use the already used password. maxLength: 128 minLength: 1 type: string passwordReuseTime: description: Number of days before which a password cannot be reused. maxLength: 128 minLength: 1 type: string passwordRolloverTime: description: Number of days the password rollover is allowed. Minimum value can be 1/24 day (1 hour) to 60 days. maxLength: 128 minLength: 1 type: string passwordVerificationFunction: description: Name of the PL/SQL that can be used for password verification. maxLength: 255 minLength: 1 type: string passwordVerificationFunctionDetails: description: Details about the PL/SQL that can be used for password verification. minLength: 1 type: string privateSga: description: 'Specify the amount of private space a session can allocate in the shared pool of the system global area (SGA), expressed in bytes. ' maxLength: 128 minLength: 1 type: string profileName: description: The name of the profile. maxLength: 128 minLength: 1 type: string sessionsPerUser: description: Specify the number of concurrent sessions to which you want to limit the user. maxLength: 128 minLength: 1 type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string userAssessmentId: description: The OCID of the user assessment corresponding to the target under consideration. maxLength: 255 minLength: 1 type: string userCount: description: The number of users that have a given profile. format: int32 type: integer required: - userAssessmentId - profileName type: object AuditEventCollection: description: Collection of audit event summary. properties: items: description: Array of audit event summary. items: $ref: '#/components/schemas/AuditEventSummary' type: array required: - items type: object UpdateSecurityPolicyDetails: description: Details to update the security policy. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object ChangeSqlCollectionCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the SQL collection. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object CreatePeerTargetDatabaseDetails: description: The details used to register the peer database of a database already registered in Data Safe. properties: databaseDetails: $ref: '#/components/schemas/DatabaseDetails' dataguardAssociationId: description: The OCID of the Data Guard Association resource in which the database being registered is considered as peer database to the primary database. maxLength: 255 minLength: 1 type: string description: description: The description of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the peer target database in Data Safe. The name is modifiable and does not need to be unique. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format TargetDatbase tlsConfig: $ref: '#/components/schemas/TlsConfig' required: - databaseDetails type: object ChangeTargetDatabaseGroupCompartmentDetails: description: The details used to change the compartment of the target database group. properties: compartmentId: description: The OCID of the compartment to which the target database group should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId AlertAggregationItems: description: Details of alerts aggregation items. properties: count: description: Total count of aggregated values. format: int64 type: integer dimensions: $ref: '#/components/schemas/AlertsAggregationDimension' metricName: description: The name of the aggregation. maxLength: 100 minLength: 1 type: string timeEnded: description: The time at which the aggregation ended. format: date-time type: string timeStarted: description: The time at which the aggregation started. format: date-time type: string required: - metricName - timeStarted - timeEnded - count type: object SecurityPolicyReportSummary: description: The resource represents a container for all the security policy reports in Data Safe. properties: compartmentId: description: The OCID of the compartment that contains the security policy report. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy report. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy report. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy report. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy report. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy report. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: CREATING type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyReportLifecycleState' targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the security policy report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the security policy report was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - timeCreated - targetId - displayName - lifecycleState type: object BulkCreateUnifiedAuditPolicyDetails: description: The details required to bulk create unified audit policies. properties: compartmentId: description: The OCID of the compartment in which to create the unified audit policy. maxLength: 255 minLength: 1 type: string policyNames: description: 'The list of unified audit policy names to be imported. ' items: maxLength: 255 minLength: 0 type: string maxItems: 1000 type: array x-default-description: 'null' securityPolicyId: description: The OCID of the security policy corresponding to the unified audit policy. maxLength: 255 minLength: 1 type: string shouldPreserveCasing: default: false description: "Indicates whether the casing of the policy names provided in the request payload should be preserved during creation. \nBy default all policy names will be converted to upper case.\n" type: boolean targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string unifiedAuditPolicyDefinitionIds: description: "The list of unified audit policy definition ocids.\nIf unified audit policy definition ids are provided, the imported\naudit policy will be associated to the specified unified audit policy\ndefinition based on the policy name.\nElse, for every audit policy that gets imported, \na new unified audit policy definition will be created.\n" items: maxLength: 255 minLength: 0 type: string maxItems: 1000 type: array x-default-description: 'null' required: - securityPolicyId - compartmentId - targetId type: object MatchingCriteria: description: 'Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria). ' example: "\"matchingCriteria\": {\n \"include\": {\n \"compartments\": [\n { id:\"ocid1.compartment.oc1..your_compartment_id_1\" },\n { id:\"ocid1.compartment.oc1..your_compartment_id_2\", isIncludeSubtree: true }\n ],\n \"targetDatabaseIds\": [\n \"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_1\",\n \"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_2\"\n ],\n \"definedTags\": {\n \"Operations\": { \"CostCenter\": [\"42\", \"84\"] },\n \"dbspmo\": { \"LastAccessed\": [\"your.email1@oracle.com\", \"your.email2@oracle.com\"] }\n },\n \"freeformTags\": {\n \"environment\": \"dev\",\n \"team\": \"datasafe\"\n },\n \"freeformTagsIn\": {\n \"environment\": [\"dev\", \"test\", \"prod\"],\n \"ownerEmail\": \"your.email1@oracle.com\"\n },\n \"systemTags\": {\n \"Oracle-Tags\": {\n \"CreatedBy\": [\"oracle/oci\", \"your.email1@oracle.com\"],\n \"CreatedOn\": \"2026-01-01\"\n },\n \"Cloud\": {\n \"cloud\": [\"OCI\", \"AWS\"]\n }\n }\n },\n \"exclude\": {\n \"targetDatabaseIds\": [\n \"ocid1.datasafetargetdatabase.oc1.iad.your_target_database_id_3\"\n ]\n }\n}\n" properties: exclude: $ref: '#/components/schemas/Exclude' include: $ref: '#/components/schemas/Include' required: - include type: object CreateSqlCollectionDetails: description: Details for SQL collection creation. properties: compartmentId: description: The OCID of the compartment containing the SQL collection. maxLength: 100 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL collection. maxLength: 400 minLength: 1 type: string x-default-description: This field will be set to null if not provided. displayName: description: The display name of the SQL collection. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format SqlCollection if not provided. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object sqlLevel: default: ALL_SQL description: 'Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string status: default: ENABLED description: Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation. enum: - ENABLED - DISABLED type: string targetId: description: The OCID of the target corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string required: - compartmentId - targetId - dbUserName type: object DatabaseTableAccessEntryCollection: description: A collection of database table access summary objects. properties: items: description: An array of database table access summary objects. items: $ref: '#/components/schemas/DatabaseTableAccessEntrySummary' type: array required: - items type: object TemplateAnalyticsSummary: description: The summary of template analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/TemplateAnalyticsDimensions' metricName: description: The name of the aggregation metric. enum: - TEMPLATE_STATS type: string required: - metricName - count type: object FindingSummary: description: The particular finding reported by the security assessment. properties: assessmentId: description: The OCID of the assessment that generated this finding. type: string category: description: The category to which the finding belongs to. type: string details: description: The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. type: object doclink: description: Documentation link provided by Oracle that explains a specific security finding or check. maxLength: 2048 type: string hasTargetDbRiskLevelChanged: default: false description: Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. type: boolean isRiskModified: default: false description: Determines if this risk level was modified by user. type: boolean isTopFinding: description: Indicates whether a given finding is marked as topFinding or not. type: boolean justification: description: User provided reason for accepting or modifying this finding if they choose to do so. maxLength: 4000 minLength: 1 type: string key: description: The unique finding key. This is a system-generated identifier. To get the finding key for a finding, use ListFindings. type: string lifecycleDetails: description: Details about the current state of the finding. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the finding. enum: - ACTIVE - UPDATING - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/FindingLifecycleState' oneline: description: Provides a recommended approach to take to remediate the finding reported. type: string oracleDefinedSeverity: description: The severity of the finding as determined by security assessment. This cannot be modified by user. type: string x-obmcs-enumref: '#/definitions/Finding/severity' references: $ref: '#/components/schemas/References' description: Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, a STIG rule, or a GDPR Article/Recital. remarks: description: The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. type: string severity: description: The severity of the finding as determined by security assessment and is same as oracleDefinedSeverity, unless modified by user. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string summary: description: The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. type: string targetId: description: The OCID of the target database. type: string timeUpdated: description: 'The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeValidUntil: description: The time until which the change in severity(deferred / modified) of this finding is valid. format: date-time type: string title: description: The short title for the finding. type: string OnPremConnector: description: A Data Safe on-premises connector that enables Data Safe to connect to on-premises databases. properties: availableVersion: description: Latest available version of the on-premises connector. type: string compartmentId: description: The OCID of the compartment that contains the on-premises connector. maxLength: 255 minLength: 1 type: string createdVersion: description: Created version of the on-premises connector. type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the on-premises connector. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the on-premises connector. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the on-premises connector. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the on-premises connector. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the on-premises connector. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OnPremConnectorLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the on-premises connector was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState type: object FindingAnalyticsSummary: description: "The summary of information about the analytics data of findings or top findings. \nIt includes details such as metric name, findingKey, \ntitle (topFindingCategory for top finding), severity (topFindingStatus for top finding) and targetId.\n" properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/FindingAnalyticsDimensions' metricName: description: The name of the aggregation metric. enum: - TOP_FINDING_STATS - FINDING_STATS type: string required: - metricName - count type: object MaskingObjectSummary: description: Summary of a masking object present in a masking policy. properties: objectName: description: The database object that contains the masking column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the masking column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' schemaName: description: The database schema that contains the masking column. maxLength: 128 minLength: 1 type: string required: - schemaName - objectName - objectType type: object ChangeMaskingPolicyCompartmentDetails: description: Details to change the compartment of a masking policy. properties: compartmentId: description: The OCID of the compartment where the masking policy should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object MaskingReportCollection: description: A collection of masking report summary objects. properties: items: description: An array of masking report summary objects. items: $ref: '#/components/schemas/MaskingReportSummary' type: array required: - items type: object EntryDetails: description: Details specific to the security policy entry. discriminator: propertyName: entryType properties: entryType: description: 'The security policy entry type. Allowed values: - FIREWALL_POLICY - The SQL Firewall policy entry type. - AUDIT_POLICY - The audit policy entry type. ' enum: - FIREWALL_POLICY - AUDIT_POLICY type: string required: - entryType type: object UpdateReportDefinitionDetails: description: Description of a new report definition. properties: columnFilters: description: An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden. items: $ref: '#/components/schemas/columnFilter' type: array columnInfo: description: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user). items: $ref: '#/components/schemas/column' type: array columnSortings: description: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc. items: $ref: '#/components/schemas/columnSorting' type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the report definition. maxLength: 400 minLength: 1 type: string displayName: description: Specifies the name of the report definition. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object summary: description: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user). items: $ref: '#/components/schemas/summary' type: array required: - displayName - columnInfo - columnFilters - columnSortings - summary type: object AlertCollection: description: Collection of alert summary. properties: items: description: Array of alert summary items: $ref: '#/components/schemas/AlertSummary' type: array required: - items type: object UpdateAuditProfileDetails: description: The details used to update the audit profile. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit profile. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit profile. The name does not have to be unique, and it's updatable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isOverrideGlobalPaidUsage: description: 'Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see [Data Safe Price List](https://www.oracle.com/cloud/price-list/#data-safe). ' type: boolean isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean type: object PolicyCondition: description: The audit policy provisioning conditions. discriminator: propertyName: entityType properties: entitySelection: description: Specifies whether to include or exclude the specified users or roles. enum: - INCLUDE - EXCLUDE type: string entityType: description: The type of users or roles that the unified audit policy is applied to. enum: - USER - ROLE - ALL_USERS - ATTRIBUTE_SET type: string operationStatus: description: The operation status that the policy must be enabled for. enum: - SUCCESS - FAILURE - BOTH type: string required: - entitySelection - entityType - operationStatus type: object UpdateTargetDatabaseGroupDetails: description: The information required to update the target database group. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the target database group. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The name of the target database group. maxLength: 255 minLength: 1 type: string x-default-description: this field will be set to a value in the format TargetDatbase freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object matchingCriteria: $ref: '#/components/schemas/MatchingCriteria' type: object RoleGrantPathCollection: description: A collection of role grant path summary objects. properties: items: description: An array of grant path summary objects. items: $ref: '#/components/schemas/RoleGrantPathSummary' type: array required: - items type: object PatchTargetAlertPolicyAssociationDetails: description: The details used to create associations for target databases and audit policies. properties: compartmentId: description: The OCID of the compartment that contains the alerts. maxLength: 100 minLength: 1 type: string items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' type: array required: - items - compartmentId type: object ColumnSourceDetails: description: The source of masking columns. discriminator: propertyName: columnSource properties: columnSource: description: The source of masking columns. enum: - TARGET - SENSITIVE_DATA_MODEL type: string required: - columnSource type: object OnPremConnectorSummary: description: Summary of a Data Safe on-premises connector. properties: compartmentId: description: The OCID of the compartment that contains the on-premises connector. maxLength: 100 minLength: 1 type: string createdVersion: description: Created version of the on-premises connector. type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the on-premises connector. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the on-premises connector. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the on-premises connector. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the on-premises connector. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the on-premises connector. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OnPremConnectorLifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the on-premises connector was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState type: object TargetAlertPolicyAssociationSummary: description: A summary of target to alert policy association. properties: compartmentId: description: The OCID of the compartment that contains the target-alert policy association. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Describes the target-alert policy association. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target-alert policy association. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the target-alert policy association. example: ocid1.datasafetargetalertpolicyAssociation.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Indicates if the target-alert policy association is enabled or disabled by user. type: boolean lifecycleState: description: The current state of the target-alert policy association. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: CREATING type: string x-obmcs-top-level-enum: '#/definitions/AlertPolicyLifecycleState' policyId: description: The OCID of the alert policy. example: ocid1.datasafealertpolicy.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokffw maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target or target database group on which alert policy is to be applied. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the target alert policy association. type: string x-obmcs-enumref: '#/definitions/TargetAlertPolicyAssociation/targetType' timeCreated: description: Creation date and time of the target-alert policy association, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: Last date and time the target-alert policy association was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState type: object BulkDeleteSqlFirewallAllowedSqlsDetails: description: Details of the allowed SQLs to be deleted from the SQL firewall policy. properties: selection: $ref: '#/components/schemas/SelectionDetails' sqlFirewallPolicyId: description: The OCID of the SQL firewall policy whose allowed SQLs needs to be deleted. maxLength: 255 minLength: 1 type: string required: - sqlFirewallPolicyId - selection type: object CreateSensitiveDataModelDetails: description: 'Details to create a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later. To specify some schemas and sensitive types for data discovery, use schemasForDiscovery and sensitiveTypeIdsForDiscovery attributes. But if you want to include all schemas and sensitive types, you can set isIncludeAllSchemas and isIncludeAllSensitiveTypes attributes to true. In the latter case, you do not need to list all schemas and sensitive types. ' properties: appSuiteName: default: GENERIC description: The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications. type: string compartmentId: description: The OCID of the compartment where the sensitive data model should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive data model. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the sensitive data model. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: SensitiveDataModel_ freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isAppDefinedRelationDiscoveryEnabled: default: false description: 'Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It''s disabled by default and should be used only if there is a need to identify application-level relationships. ' type: boolean isIncludeAllSchemas: default: false description: 'Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). ' type: boolean isIncludeAllSensitiveTypes: default: false description: 'Indicates if all the existing sensitive types should be used by data discovery jobs. If it''s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. ' type: boolean isSampleDataCollectionEnabled: default: false description: 'Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it''s disabled by default and should be used only if it''s acceptable to store sample data in Data Safe''s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. ' type: boolean schemasForDiscovery: default: 'null' description: The schemas to be scanned by data discovery jobs. items: maxLength: 128 minLength: 1 type: string type: array sensitiveTypeGroupIdsForDiscovery: description: 'The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array x-default-description: 'null' sensitiveTypeIdsForDiscovery: default: 'null' description: 'The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery. ' items: maxLength: 255 minLength: 1 type: string type: array tablesForDiscovery: default: 'null' description: "The data discovery jobs will scan the tables specified here, including both schemas and tables.\nFor instance, the input could be in the format: [{schemaName: \"HR\", tableName: [\"T1\", \"T2\"]}, {schemaName: \n\"OE\", tableName : [\"T3\", \"T4\"]}].\n" items: $ref: '#/components/schemas/TablesForDiscovery' maxItems: 1000 type: array targetId: description: 'The OCID of the reference target database to be associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - targetId type: object DiscoveryJobResult: description: 'A discovery job result representing a sensitive column. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified. ' properties: appDefinedChildColumnKeys: description: Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array appName: description: The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed. maxLength: 128 minLength: 1 type: string columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string dbDefinedChildColumnKeys: description: Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array discoveryJobId: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string discoveryType: description: 'The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified. ' enum: - NEW - MODIFIED - DELETED type: string estimatedDataValueCount: description: The estimated number of data values the column has in the associated database. format: int64 type: integer isResultApplied: default: false description: 'Indicates whether the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model. ' type: boolean key: description: The unique key that identifies the discovery result. maxLength: 255 minLength: 1 type: string modifiedAttributes: $ref: '#/components/schemas/ModifiedAttributes' objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string parentColumnKeys: description: Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. items: maxLength: 255 minLength: 1 type: string type: array plannedAction: description: 'Specifies how to process the discovery result. It''s set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn''t change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren''t reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results. ' enum: - NONE - ACCEPT - INVALIDATE - REJECT type: string relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sampleDataValues: description: 'Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. ' items: maxLength: 4000 minLength: 1 type: string type: array schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveColumnkey: description: The unique key that identifies the sensitive column represented by the discovery result. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the sensitive column. maxLength: 255 minLength: 1 type: string required: - key - discoveryType - schemaName - objectName - columnName - objectType - dataType - relationType - estimatedDataValueCount - plannedAction - isResultApplied - discoveryJobId type: object SqlCollectionLogAggregation: description: The details of SQL collection log aggregation items. properties: count: description: Total count of aggregated value. format: int64 type: integer dimensions: $ref: '#/components/schemas/SqlCollectionLogDimensions' metricName: description: Name of the aggregation. maxLength: 128 minLength: 0 type: string timeEnded: description: The time at which the aggregation ended. format: date-time type: string timeStarted: description: The time at which the aggregation started. format: date-time type: string required: - metricName - count type: object BulkCreateSqlFirewallAllowedSqlsDetails: description: The details used to append the violation logs as allowed SQLs properties: logType: description: The type of log to be added as an allowed sql. enum: - VIOLATION_LOG type: string x-obmcs-top-level-enum: '#/definitions/LogType' selection: $ref: '#/components/schemas/SelectionDetails' sqlFirewallPolicyId: description: The OCID of the SQL firewall policy where new allowed SQLs needs to be added. maxLength: 255 minLength: 1 type: string required: - sqlFirewallPolicyId - logType - selection type: object DatabaseViewAccessEntrySummary: description: Summary of DatabaseViewAccess Object. properties: accessType: description: 'The type of the access the user has on the table, there can be one or more from SELECT, DELETE, INSERT, READ or UPDATE. ' enum: - SELECT - UPDATE - INSERT - DELETE - OWNER type: string x-obmcs-top-level-enum: '#/definitions/AccessType' columnName: description: The name of column when there are column level privileges on a table or view. maxLength: 255 minLength: 1 type: string grantFromRole: description: "This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the \nrole which is granted to the user though which the user has access to the table.\n" maxLength: 255 minLength: 1 type: string grantee: description: Grantee is the user who can access the view. maxLength: 255 minLength: 1 type: string grantor: description: The user who granted the privilege. maxLength: 255 minLength: 1 type: string isAccessConstrainedByDatabaseVault: description: Indicates whether the table access is constrained via Oracle Database Vault. type: boolean isAccessConstrainedByRealApplicationSecurity: description: Indicates whether the view access is constrained via Real Application Security. type: boolean isAccessConstrainedByRedaction: description: Indicates whether the view access is constrained via Oracle Data Redaction. type: boolean isAccessConstrainedBySqlFirewall: description: Indicates whether the view access is constrained via Oracle Database SQL Firewall. type: boolean isAccessConstrainedByVirtualPrivateDatabase: description: Indicates whether the view access is constrained via Virtual Private Database. type: boolean key: description: The unique key that identifies the view report. It is numeric and unique within a security policy report. maxLength: 255 minLength: 1 type: string privilege: description: The name of the privilege. enum: - SELECT - UPDATE - INSERT - DELETE - READ - OWNER - INDEX - SELECT_ANY_TABLE - UPDATE_ANY_TABLE - INSERT_ANY_TABLE - DELETE_ANY_TABLE - READ_ANY_TABLE - CREATE_ANY_INDEX type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeName' privilegeGrantable: description: "Indicates whether the grantee can grant this privilege to other users. Privileges can be granted to a user or role with \nGRANT_OPTION or ADMIN_OPTION\n" enum: - ADMIN_OPTION - GRANT_OPTION type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeGrantableOption' privilegeType: description: 'Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. ' maxLength: 400 minLength: 1 type: string tableName: description: The name of the table. maxLength: 255 minLength: 1 type: string tableSchema: description: The name of the schema maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string viewName: description: The name of the view. maxLength: 255 minLength: 1 type: string viewSchema: description: The name of the schema. maxLength: 255 minLength: 1 type: string viewText: description: The definition of the view. maxLength: 255 minLength: 1 type: string required: - key - grantee type: object CreateColumnSourceDetails: description: Details to associate a column source with a masking policy. discriminator: propertyName: columnSource properties: columnSource: description: The source of masking columns. enum: - TARGET - SENSITIVE_DATA_MODEL type: string required: - columnSource type: object TableSummary: description: The details of a table fetched from the database. properties: schemaName: description: Name of the schema. maxLength: 128 minLength: 1 type: string tableName: description: Name of the table. maxLength: 128 minLength: 1 type: string required: - tableName - schemaName type: object PatchGroupedSensitiveTypesDetails: description: Details to patch sensitive types in a sensitive type group. INSERT and REMOVE operations are allowed. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object DifferenceColumn: description: 'A SDM masking policy difference column. It can be one of the following three types: NEW: A new column in the sensitive data model that is not in the masking policy. DELETED: A column that is present in the masking policy but has been deleted from the sensitive data model. MODIFIED: A column that is present in the masking policy as well as the sensitive data model but some of its attributes have been modified. ' properties: columnName: description: The name of the difference column. maxLength: 128 minLength: 1 type: string differenceType: description: 'The type of the SDM masking policy difference column. It can be one of the following three types: NEW: A new sensitive column in the sensitive data model that is not in the masking policy. DELETED: A column that is present in the masking policy but has been deleted from the sensitive data model. MODIFIED: A column that is present in the masking policy as well as the sensitive data model but some of its attributes have been modified. ' enum: - NEW - MODIFIED - DELETED type: string key: description: The unique key that identifies the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string maskingColumnkey: description: The unique key that identifies the masking column represented by the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string objectName: description: The database object that contains the difference column. maxLength: 128 minLength: 1 type: string plannedAction: description: 'Specifies how to process the difference column. It''s set to SYNC by default. Use the PatchSdmMaskingPolicyDifferenceColumns operation to update this attribute. You can choose one of the following options: SYNC: To sync the difference column and update the masking policy to reflect the changes. NO_SYNC: To not sync the difference column so that it doesn''t change the masking policy. After specifying the planned action, you can use the ApplySdmMaskingPolicyDifference operation to automatically process the difference columns. ' enum: - SYNC - NO_SYNC type: string schemaName: description: The database schema that contains the difference column. maxLength: 128 minLength: 1 type: string sensitiveColumnkey: description: The unique key that identifies the sensitive column represented by the SDM masking policy difference column. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the difference column. maxLength: 255 minLength: 1 type: string syncStatus: default: NOT_SYNCED description: "Indicates if the difference column has been processed. Use GetDifferenceColumn operation to \ntrack whether the difference column has already been processed and applied to the masking policy.\n" enum: - SYNCED - NOT_SYNCED type: string timeLastSynced: description: The date and time the SDM masking policy difference column was last synced, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - key - differenceType - schemaName - objectName - columnName - plannedAction - syncStatus type: object ChangeTargetDatabaseCompartmentDetails: description: The details used to change the compartment of a Data Safe target database. properties: compartmentId: description: The OCID of the compartment you want to move the Data Safe target database to. example: ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnxernheayom3pljsfppca maxLength: 100 minLength: 1 type: string required: - compartmentId UpdateAuditTrailDetails: description: The details used to update an audit trail. properties: canUpdateLastArchiveTimeOnTarget: default: true description: 'Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. ' type: boolean definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit trail. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit trail. The name does not have to be unique, and it's updatable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isAutoPurgeEnabled: default: false description: 'Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database''s audit trail does not become too large. ' type: boolean type: object RegistrationPolicySummary: description: 'A summary of a registration policy. This object contains key information about a registration policy, including its ID, compartment ID, display name, and lifecycle state. ' properties: compartmentId: description: The OCID for the compartment containing the registration policy. maxLength: 255 minLength: 1 type: string connectionOption: $ref: '#/components/schemas/PolicyConnectionOption' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the registration policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the registration policy. maxLength: 255 minLength: 1 type: string enablementLevel: description: The type of resource that is opted-in for the registration policy. type: string x-obmcs-enumref: '#/definitions/RegistrationPolicy/enablementLevel' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the registration policy. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the registration policy. type: string x-obmcs-enumref: '#/definitions/RegistrationPolicy/lifecycleState' lifecycleStateDetails: description: Details about the lifecycle state of the registration policy. maxLength: 1000 minLength: 1 type: string resourceId: description: The OCID of the resource used in the registration policy. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time when the registration policy was created. format: date-time type: string timeUpdated: description: The date and time when the registration policy was last updated. format: date-time type: string required: - id - compartmentId - displayName - enablementLevel - resourceId - lifecycleState - connectionOption - timeCreated - timeUpdated - freeformTags - definedTags - systemTags type: object DataSafeConfiguration: description: A Data Safe configuration for a tenancy and region. properties: compartmentId: description: The OCID of the tenancy used to enable Data Safe. maxLength: 255 minLength: 1 type: string dataSafeNatGatewayIpAddress: description: 'The Oracle Data Safe''s NAT Gateway IP Address. ' maxLength: 46 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object globalSettings: $ref: '#/components/schemas/GlobalSettings' isEnabled: description: Indicates if Data Safe is enabled. type: boolean lifecycleState: description: The current state of Data Safe. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NA type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' timeEnabled: description: The date and time Data Safe was enabled, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string url: description: The URL of the Data Safe service. type: string required: - isEnabled type: object TemplateAssociationAnalyticsCollection: description: The collection of template association analytics summary. properties: items: description: The array of template association analytics summary. items: $ref: '#/components/schemas/TemplateAssociationAnalyticsSummary' type: array required: - items type: object Exclude: description: Criteria to exclude certain target databases from the target database group. properties: targetDatabaseIds: description: The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria). items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array uniqueItems: true required: - targetDatabaseIds type: object AuditTrailSummary: description: Summary of an audit trail. properties: auditCollectionStartTime: description: The date from which the audit trail must start collecting data, in the format defined by RFC3339. format: date-time type: string auditProfileId: description: The OCID of the parent audit. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the audit. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of audit trail. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit trail. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit trail. maxLength: 255 minLength: 1 type: string isAutoPurgeEnabled: default: false description: 'Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database''s audit trail does not become too large. ' type: boolean lifecycleDetails: description: Details about the current state of the audit trail in Data Safe. This attribute will be deprecated, but will still be available in GET audit trail response. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit trail. enum: - INACTIVE - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailLifecycleState' peerTargetDatabaseKey: description: The secondary id assigned for the peer database registered with Data Safe. type: integer status: description: The current sub-state of the audit trail. enum: - STARTING - COLLECTING - RECOVERING - IDLE - STOPPING - STOPPED - RESUMING - RETRYING - NOT_STARTED - STOPPED_NEEDS_ATTN - STOPPED_FAILED type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailStatus' targetId: description: The OCID of the Data Safe target for which the audit trail is created. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the audit trail was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the audit trail was updated, in the format defined by RFC3339. format: date-time type: string trailLocation: description: An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. maxLength: 4000 type: string required: - id - lifecycleState - status - displayName - timeCreated - timeUpdated - auditProfileId - targetId - compartmentId type: object summary: description: Summary of the audit report. properties: countOf: description: Name of the key or count of object. maxLength: 255 minLength: 1 type: string displayOrder: description: Specifies the order in which the summary must be displayed. format: int32 type: integer groupByFieldName: description: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary. maxLength: 255 minLength: 1 type: string isHidden: default: true description: Indicates if the summary is hidden. Values can either be 'true' or 'false'. type: boolean name: description: Name of the report summary. maxLength: 255 minLength: 1 type: string scimFilter: description: Additional scim filters used to get the specific summary. maxLength: 4000 minLength: 1 type: string required: - name - displayOrder type: object UpdateUnifiedAuditPolicyDefinitionDetails: description: Details to update the audit policy. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit policy. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object ReportDefinitionSummary: description: Summary of report definition. properties: category: description: Specifies the name of the category that this report belongs to. enum: - CUSTOM_REPORTS - SUMMARY - ACTIVITY_AUDITING - FIREWALL_VIOLATIONS - ALLOWED_SQL type: string compartmentId: description: The OCID of the compartment containing the report definition. maxLength: 255 minLength: 1 type: string complianceStandards: description: The list of data protection regulations/standards used in the report that will help demonstrate compliance. items: maxLength: 255 minLength: 1 type: string maxItems: 30 type: array dataSource: description: Specifies the name of a resource that provides data for the report. For example alerts, events. enum: - EVENTS - ALERTS - VIOLATIONS - ALLOWED_SQL type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionDataSource' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the report definition. maxLength: 400 minLength: 1 type: string displayName: description: Name of the report definition. maxLength: 255 minLength: 1 type: string displayOrder: description: Specifies how the report definitions are ordered in the display. format: int32 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the report definition. maxLength: 255 minLength: 1 type: string isSeeded: description: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'. type: boolean lifecycleState: description: The current state of the audit report. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionLifecycleState' schedule: description: 'The schedule to generate the report periodically in the specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A work request is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ''*''. When not, day of week must equal the given value. 5. can be either ''*'' (without quotes or a number between 1 and 28) No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to generate a report at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to generate a report at 13:30:00 every Tuesday 3. "0 30 13 * 3" - This indicates to generate a report at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string timeCreated: description: Specifies the time at which the report definition was created. format: date-time type: string timeUpdated: description: The date and time of the report definition update in Data Safe. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated type: object CreateDataSafePrivateEndpointDetails: description: The details used to create the new Data Safe private endpoint. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the private endpoint. maxLength: 1024 minLength: 1 type: string displayName: description: The display name for the private endpoint. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'The OCIDs of the network security groups that the private endpoint belongs to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateEndpointIp: description: The private IP address of the private endpoint. maxLength: 46 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' maxProperties: 25 type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' maxProperties: 10 type: object subnetId: description: The OCID of the subnet. maxLength: 255 minLength: 1 type: string vcnId: description: The OCID of the VCN. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId - vcnId - subnetId type: object DiscoveryJob: description: A data discovery job. It helps track job's metadata as well as result statistics. properties: compartmentId: description: The OCID of the compartment that contains the discovery job. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object discoveryType: description: 'The type of the discovery job. It defines the job''s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. ' enum: - ALL - NEW - MODIFIED - DELETED type: string displayName: description: The display name of the discovery job. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string isAppDefinedRelationDiscoveryEnabled: description: 'Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It''s disabled by default and should be used only if there is a need to identify application-level relationships. ' type: boolean isIncludeAllSchemas: description: 'Indicates if all the schemas in the associated target database are used for data discovery. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). ' type: boolean isIncludeAllSensitiveTypes: description: 'Indicates if all the existing sensitive types are used for data discovery. If it''s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used. ' type: boolean isSampleDataCollectionEnabled: description: 'Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it''s disabled by default and should be used only if it''s acceptable to store sample data in Data Safe''s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. ' type: boolean lifecycleState: description: The current state of the discovery job. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' schemasForDiscovery: description: The schemas used for data discovery. items: maxLength: 128 minLength: 1 type: string type: array sensitiveDataModelId: description: The OCID of the sensitive data model associated with the discovery job. maxLength: 255 minLength: 1 type: string sensitiveTypeGroupIdsForDiscovery: description: 'The OCIDs of the sensitive type groups to be used by data discovery jobs. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array sensitiveTypeIdsForDiscovery: description: The OCIDs of the sensitive types used for data discovery. items: maxLength: 255 minLength: 1 type: string type: array systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tablesForDiscovery: description: 'The data discovery jobs will scan the tables specified here, including both schemas and tables. ' items: $ref: '#/components/schemas/TablesForDiscovery' maxItems: 1000 type: array targetId: description: The OCID of the target database associated with the discovery job. maxLength: 255 minLength: 1 type: string timeFinished: description: The date and time the discovery job finished, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).. format: date-time type: string timeStarted: description: The date and time the discovery job started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string totalColumnsScanned: description: The total number of columns scanned by the discovery job. format: int64 type: integer totalDeletedSensitiveColumns: description: The total number of deleted sensitive columns identified by the discovery job. format: int64 type: integer totalModifiedSensitiveColumns: description: The total number of modified sensitive columns identified by the discovery job. format: int64 type: integer totalNewSensitiveColumns: description: The total number of new sensitive columns identified by the discovery job. format: int64 type: integer totalObjectsScanned: description: The total number of objects (tables and editioning views) scanned by the discovery job. format: int64 type: integer totalSchemasScanned: description: The total number of schemas scanned by the discovery job. format: int64 type: integer required: - id - discoveryType - displayName - lifecycleState - compartmentId - timeStarted - timeFinished - sensitiveDataModelId - targetId - isSampleDataCollectionEnabled - isAppDefinedRelationDiscoveryEnabled - isIncludeAllSchemas - isIncludeAllSensitiveTypes - totalSchemasScanned - totalObjectsScanned - totalColumnsScanned - totalNewSensitiveColumns - totalModifiedSensitiveColumns - totalDeletedSensitiveColumns type: object CreateAuditArchiveRetrievalDetails: description: Request details for creating a new archive retrieval. properties: compartmentId: description: The OCID of the compartment that contains the archival retrieval. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the archive retrieval. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the archive retrieval. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string endDate: description: End month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object startDate: description: Start month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string targetId: description: The OCID of the target associated with the archive retrieval. maxLength: 255 minLength: 1 type: string required: - compartmentId - targetId - startDate - endDate type: object MaskingColumnCollection: description: A collection of masking column summary objects. properties: items: description: An array of masking column summary objects. items: $ref: '#/components/schemas/MaskingColumnSummary' type: array required: - items type: object SensitiveTypesExportSummary: description: 'The resource represents collection of sensitive types needed to be exported. ' properties: compartmentId: description: The OCID of the compartment that contains sensitive types export. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive types export. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive types export. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the sensitive types export. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the sensitive types export. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypesExportLifecycleState' timeCreated: description: The date and time the sensitive types export was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the sensitive types export was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object UpdateLibraryMaskingFormatDetails: description: 'Details to update a library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries. ' properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the library masking format. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the library masking format. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string formatEntries: description: An array of format entries. The combined output of all the format entries is used for masking. items: $ref: '#/components/schemas/FormatEntry' maxItems: 100 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object sensitiveTypeIds: description: An array of OCIDs of the sensitive types compatible with the library masking format. items: maxLength: 255 minLength: 1 type: string type: array type: object MaskingErrorSummary: description: Summary of a masking error. A Masking error is an error seen during the masking run. properties: error: description: The text of the masking error. maxLength: 4000 minLength: 1 type: string failedStatement: description: The statement resulting into the error. maxLength: 4000 minLength: 1 type: string stepName: description: The stepName of the masking error. enum: - VALIDATE - GENERATE_SCRIPT - EXECUTE_MASKING - PRE_MASKING - POST_MASKING type: string timeCreated: description: 'The date and time the error entry was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - stepName - error - timeCreated type: object SecurityPolicy: description: 'The resource represents as a container for all the security policies in Data Safe. ' properties: compartmentId: description: The OCID of the compartment containing the security policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy. enum: - CREATING - UPDATING - ACTIVE - FAILED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyLifecycleState' securityPolicyType: description: The type of the security policy. enum: - DATASAFE_MANAGED - SEEDED_POLICY type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time that the security policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the security policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object UnifiedAuditPolicyDefinition: description: 'Resource represents a single unified audit policy definition. ' properties: auditPolicyCategory: description: The category to which the unified audit policy belongs in the target database. enum: - BASIC_ACTIVITY - ADMIN_USER_ACTIVITY - USER_ACTIVITY - ORACLE_PREDEFINED - COMPLIANCE_STANDARD - SQL_FIREWALL_AUDITING - CUSTOM type: string compartmentId: description: The OCID of the compartment containing the unified audit policy definition. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy definition. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the unified audit policy definition. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the unified audit policy definition. maxLength: 255 minLength: 1 type: string isSeeded: description: Signifies whether the unified audit policy definition is seeded or not. type: boolean lifecycleDetails: description: Details about the current state of the unified audit policy definition. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the unified audit policy definition. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyDefinitionLifecycleState' policyDefinitionStatement: description: The definition of the unified audit policy to be provisioned in the target database. maxLength: 32767 minLength: 1 type: string policyName: description: The unified audit policy name in the target database. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the unified audit policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the unified audit policy was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated type: object AuditTrailDimensions: description: Details of aggregation dimensions used for summarizing audit trails. properties: lifecycleState: description: The current state of the audit trail. enum: - INACTIVE - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/AuditTrailLifecycleState' location: description: The location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. maxLength: 255 minLength: 1 type: string status: description: The current sub-state of the audit trail.. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the Data Safe target for which the audit trail is created. maxLength: 255 minLength: 1 type: string type: object UnifiedAuditPolicyDefinitionCollection: description: Collection of audit policy summary. properties: items: description: Array of audit policy summary. items: $ref: '#/components/schemas/UnifiedAuditPolicyDefinitionSummary' type: array required: - items type: object ApplyDiscoveryJobResultsDetails: description: Details to apply the discovery results to a sensitive data model. properties: discoveryJobId: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string required: - discoveryJobId type: object RunUserAssessmentDetails: description: The details required to create an on-demand saved user assessment. properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string x-default-description: If a value is not provided, this field is automatically set to the latest assessment compartment. definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the user assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the user assessment. maxLength: 255 minLength: 1 type: string x-default-description: If a value is not provided, this field is automatically set to a value in the format UA . freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object ChangeAuditPolicyCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the audit policy. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object TargetDatabaseSummary: description: Summary of a Data Safe target database. properties: associatedResourceIds: description: The OCIDs of associated resources like database, Data Safe private endpoint etc. items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: The OCID of the compartment that contains the Data Safe target database. example: ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnxernheayom3pljsfppca maxLength: 100 minLength: 1 type: string databaseType: description: The database type. enum: - DATABASE_CLOUD_SERVICE - AUTONOMOUS_DATABASE - INSTALLED_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseType' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target database in Data Safe. maxLength: 255 minLength: 1 type: string features: description: List of enabled features based on granted ORA_DSCS_* roles in target database items: type: string type: array x-default-description: 'null' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Data Safe target database. maxLength: 255 minLength: 1 type: string infrastructureType: description: The infrastructure type the database is running on. enum: - ORACLE_CLOUD - CLOUD_AT_CUSTOMER - ON_PREMISES - NON_ORACLE_CLOUD type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureType' lifecycleDetails: description: Details about the current state of the target database in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the target database in Data Safe. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the database was registered in Data Safe and created as a target database in Data Safe. format: date-time type: string required: - id - compartmentId - displayName - databaseType - infrastructureType - lifecycleState - timeCreated type: object CreateSecurityPolicyConfigDetails: description: The details to create the security policy configuration. properties: compartmentId: description: The OCID of the compartment containing the security policy configuration. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy configuration. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string firewallConfig: $ref: '#/components/schemas/FirewallConfigDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object securityPolicyId: description: The OCID of the security policy corresponding to the security policy configuration. maxLength: 255 minLength: 1 type: string unifiedAuditPolicyConfig: $ref: '#/components/schemas/UnifiedAuditPolicyConfigDetails' required: - compartmentId - securityPolicyId type: object MaskingFormat: description: "A masking format defines the logic to mask data in a database column. The condition attribute \ndefines the condition that must be true for applying the masking format. It enables you to do \nconditional masking\nso that you can mask the column data values differently using different masking formats and \nthe associated conditions. A masking format can have one or more format entries. A format entry \ncan be a basic masking format such as Random Number, or it can be a library masking format.The \ncombined output of all the format entries is used for masking. It provides the flexibility to \ndefine a masking format that can generate different parts of a data value separately and then \ncombine them to get the final data value for masking.\n" properties: condition: description: "A condition that must be true for applying the masking format. It can be any valid \nSQL construct that can be used in a SQL predicate. It enables you to do \nconditional masking \nso that you can mask the column data values differently using different masking \nformats and the associated conditions.\n" type: string description: description: The description of the masking format. maxLength: 400 minLength: 1 type: string x-default-description: 'null' formatEntries: description: "An array of format entries. The combined output of all the format entries is \nused for masking the column data values.\n" items: $ref: '#/components/schemas/FormatEntry' type: array required: - formatEntries type: object CompareUserAssessmentDetails: description: The details of the user assessment comparison. properties: comparisonUserAssessmentId: description: 'The OCID of the user assessment to be compared. You can compare with another user assessment, a latest assessment, or a baseline. ' maxLength: 255 minLength: 1 type: string required: - comparisonUserAssessmentId type: object FindingsChangeAuditLogCollection: description: A collection of of all finding risk change audit log summary objects. properties: items: description: An array of finding risk change audit log summary objects. items: $ref: '#/components/schemas/FindingsChangeAuditLogSummary' type: array required: - items type: object GenerateReportDetails: description: Details for the report generation. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string description: description: The description of the report to be generated maxLength: 400 minLength: 1 type: string displayName: description: The name of the report to be generated maxLength: 255 minLength: 1 type: string isPaginationEnabled: default: false description: "Indicates if the reports being generated should be pagination enabled. \nIf set to true, multiple reports can be generated and the details of next and previous report are present in Report.\nValues can either be 'true' or 'false'.\n" type: boolean mimeType: description: Specifies the format of report to be .xls or .pdf or .json enum: - PDF - XLS - JSON type: string rowLimit: description: Specifies the limit on the number of rows in the report. format: int32 type: integer targetGroupIds: description: Array of target group OCIDs. items: maxLength: 255 minLength: 1 type: string maxItems: 1000 type: array targetIds: description: Array of database target OCIDs. items: maxLength: 255 minLength: 1 type: string type: array timeGreaterThan: description: Specifies the time after which the data needs to be reported. format: date-time type: string timeLessThan: description: Specifies the time until which the data needs to be reported. format: date-time type: string required: - displayName - compartmentId - mimeType type: object ChangeReportCompartmentDetails: description: The details of the compartment that the audit report is moving to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AuditArchiveRetrievalSummary: description: Summary details of an archive retrieval. properties: auditEventCount: description: Total retrieved archive records audit event count. format: int64 type: integer compartmentId: description: The OCID of the compartment that contains archive retrieval. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the archive retrieval. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the archive retrieval. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string endDate: description: End month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string errorInfo: description: Error details of failed archive retrieval. maxLength: 512 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the archive retrieval. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the archive retrieval. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the archive retrieval. enum: - CREATING - ACTIVE - NEEDS_ATTENTION - FAILED - DELETING - DELETED - UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AuditArchiveRetrievalLifecycleState' startDate: description: Start month of the archive retrieval, in the format defined by RFC3339. format: date-time type: string targetId: description: The OCID of the target associated with the archive retrieval. maxLength: 255 minLength: 1 type: string timeCompleted: description: The date time when archive retrieval request was fulfilled, in the format defined by RFC3339. format: date-time type: string timeOfExpiry: description: The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival. format: date-time type: string timeRequested: description: The date time when archive retrieval was requested, in the format defined by RFC3339. format: date-time type: string required: - id - compartmentId - displayName - startDate - endDate - targetId - lifecycleState type: object SensitiveColumnAnalyticsSummary: description: The details of sensitive column analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/SensitiveColumnAnalyticsDimensions' required: - dimensions - count type: object UpdateUserAssessmentDetails: description: Updates one or more attributes of the specified user assessment. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the user assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the user assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object schedule: description: 'The schedule for periodically saving the assessment. This is applicable only for assessments of type save schedule and latest assessment. It updates the existing schedule in a specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a user assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a user assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a user assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string type: object SqlCollectionAnalyticsCollection: description: SQL collection analytics collection. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/SqlCollectionAggregation' type: array required: - items type: object RegistrationPolicy: description: 'A registration policy. This object contains detailed information about a registration policy, including its ID, compartment ID, display name, and features. ' properties: canOverrideFeatures: description: Indicates whether features will be overridden. type: boolean compartmentId: description: The OCID for the compartment containing the registration policy. maxLength: 255 minLength: 1 type: string connectionOption: $ref: '#/components/schemas/PolicyConnectionOption' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description of the registration policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the registration policy. maxLength: 255 minLength: 1 type: string enablementLevel: description: 'The resource type which has been opted in for the registration policy. - DATABASE - The registration policy will be opted in at the Container Database level. ' enum: - DATABASE type: string features: description: The Data Safe features granted to the databases registering under the registration policy. items: enum: - ASSESSMENT - AUDIT_COLLECTION - AUDIT_SETTING - DATA_DISCOVERY - MASKING - SQL_FIREWALL - ALL type: string x-obmcs-top-level-enum: '#/definitions/RegistrationPolicyFeatures' type: array uniqueItems: true freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the registration policy. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The lifecycle state of the registration policy. - CREATING - The registration policy is getting created. - ACTIVE - The registration policy has been successfully created. - UPDATING - The registration policy is getting updated. - NEEDS_ATTENTION - The registration policy needs attention. - FAILED - The registration policy creation or update has failed. - DELETING - The registration policy is getting deleted. ' enum: - CREATING - ACTIVE - UPDATING - NEEDS_ATTENTION - FAILED - DELETING type: string lifecycleStateDetails: description: Details about the lifecycle state of the registration policy maxLength: 1000 minLength: 1 type: string resourceId: description: The OCID of the resource used in the registration policy. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time when the registration policy was created. format: date-time type: string timeUpdated: description: The date and time when the registration policy was last updated. format: date-time type: string required: - compartmentId - id - displayName - resourceId - features - lifecycleState - timeCreated - timeUpdated - freeformTags - definedTags - systemTags type: object UpdateAuditPolicyDetails: description: Details to update the audit policy. properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit policy. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object SecurityAssessment: description: 'A security assessment that provides an overall insight into your database security posture. The security assessment results are based on the analysis of your database configurations, user accounts, and security controls. For more information, see [Security Assessment Overview](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/security-assessment-overview.html). ' properties: baselineAssessmentId: description: The ocid of a security assessment which is of type TEMPLATE_BASELINE, this will be null or empty when type is TEMPLATE_BASELINE. maxLength: 255 minLength: 1 type: string checks: description: The security checks to be evaluated for type template. items: $ref: '#/components/schemas/Check' maxItems: 150 type: array compartmentId: description: The OCID of the compartment that contains the security assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security assessment. maxLength: 255 minLength: 1 type: string ignoredAssessmentIds: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array ignoredTargets: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array isBaseline: description: Indicates whether or not the security assessment is set as a baseline. This is applicable only for saved security assessments. type: boolean isDeviatedFromBaseline: description: Indicates if the assessment has deviated from the baseline. type: boolean lastComparedBaselineId: description: The OCID of the baseline against which the latest security assessment was compared. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security assessment. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security assessment. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentLifecycleState' link: description: 'The summary of findings for the security assessment ' type: string schedule: description: 'Schedule to save the assessment periodically in the specified format: ; Allowed version strings - "v1" v1''s version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either ''*'' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''*''. When not, day of week must equal the given value can be either ''*'' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''*''. When not, day of month must equal the given value ' example: '1. "0 30 13 * *" - This indicates to run a security assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a security assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a security assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string scheduleSecurityAssessmentId: description: The OCID of the security assessment that is responsible for creating this scheduled save assessment. maxLength: 255 minLength: 1 type: string statistics: $ref: '#/components/schemas/SecurityAssessmentStatistics' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseGroupId: description: The OCID of the target database group that the group assessment is created for. maxLength: 255 minLength: 1 type: string targetIds: description: Array of database target OCIDs. items: maxLength: 255 minLength: 1 type: string type: array targetType: description: Indicates whether the security assessment is for a target database or a target database group. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentTargetType' targetVersion: description: The version of the target database. type: string templateAssessmentId: description: The ocid of a security assessment which is of type TEMPLATE, this will be null or empty when type is TEMPLATE. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the security assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeLastAssessed: description: The date and time the security assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the security assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string triggeredBy: description: Indicates whether the security assessment was created by system or by a user. enum: - USER - SYSTEM type: string type: description: "The type of this security assessment. The possible types are:\n\nLATEST: The most up-to-date assessment that is running automatically for a target. It is system generated.\nSAVED: A saved security assessment. LATEST assessments are always saved in order to maintain the history of runs. A SAVED assessment is also generated by a 'refresh' action (triggered by the user).\nSAVE_SCHEDULE: The schedule for periodic saves of LATEST assessments.\nCOMPARTMENT: An automatically managed assessment type that stores all details of targets in one compartment.\n This type keeps an up-to-date assessment of all database risks in one compartment. It is automatically updated when\n the latest assessment or refresh action is executed. It is also automatically updated when a target is deleted or move to a different compartment.\n" enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT - TEMPLATE - TEMPLATE_BASELINE type: string required: - id - timeCreated - timeUpdated - lifecycleState - compartmentId - targetIds - type - displayName SensitiveColumnCollection: description: A collection of sensitive column summary objects. properties: items: description: An array of sensitive column summary objects. items: $ref: '#/components/schemas/SensitiveColumnSummary' type: array required: - items type: object SecurityPolicyConfig: description: 'The Data Safe resource represents the common configurations corresponding to the associated security policy. ' properties: compartmentId: description: The OCID of the compartment containing the security policy configuration. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy configuration. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy configuration. maxLength: 255 minLength: 1 type: string firewallConfig: $ref: '#/components/schemas/FirewallConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy configuration. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy configuration. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy configuration. enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyConfigLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the security policy configuration. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the security policy configuration was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the security policy configuration was last updated, in the format defined by RFC3339. format: date-time type: string unifiedAuditPolicyConfig: $ref: '#/components/schemas/UnifiedAuditPolicyConfig' required: - id - displayName - compartmentId - securityPolicyId - timeCreated - lifecycleState type: object AuditArchiveRetrievalCollection: description: Collection of archive retrieval summary. properties: items: description: Array of archive retrieval summary. items: $ref: '#/components/schemas/AuditArchiveRetrievalSummary' type: array required: - items type: object PatchAlertsDetails: description: The alert details to update the status of one or more alerts specified by the alert IDs. properties: compartmentId: description: The OCID of the compartment that contains the alerts. maxLength: 100 minLength: 1 type: string items: description: Array of alert detail to update the status of the alert specified by the alert ID. items: $ref: '#/components/schemas/PatchInstruction' type: array required: - items - compartmentId type: object ReportDetails: description: The details of the report schedule. discriminator: propertyName: reportType properties: reportType: description: The type of the report. enum: - AUDIT type: string required: - reportType type: object SecurityPolicyConfigCollection: description: Collection of security policy configuration summaries. properties: items: description: Array of security policy configuration summaries. items: $ref: '#/components/schemas/SecurityPolicyConfigSummary' type: array required: - items type: object AssociatedResourceCollection: description: The details of associated resources of an attribute set. properties: items: description: Array of associated resources. items: $ref: '#/components/schemas/AssociatedResourceSummary' maxItems: 100 type: array required: - items type: object UpdateOnPremConnectorWalletDetails: description: The details used to update an on-premises connector's wallet. properties: isUpdate: default: false description: Indicates whether to update or not. If false, the wallet will not be updated. Default is false. type: boolean DiscoveryAnalyticsSummary: description: Summary of discovery analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/Dimensions' metricName: description: The name of the aggregation metric. enum: - SENSITIVE_DATA_MODEL - SENSITIVE_TYPE - SENSITIVE_SCHEMA - SENSITIVE_TABLE - SENSITIVE_COLUMN - SENSITIVE_DATA_VALUE - TARGET_DATABASE type: string timeLastDiscovered: description: The date and time when data discovery was last done on the target database, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - metricName - count type: object CreateReferentialRelationDetails: description: 'A sensitive column is a resource corresponding to a database column that is considered sensitive. It''s a subresource of sensitive data model resource and is always associated with a sensitive data model. Note that referential relationships are also managed as part of sensitive columns. ' properties: child: $ref: '#/components/schemas/ColumnsInfo' isSensitive: default: false description: "Add to sensitive data model if passed true. If false is passed, then the\ncolumns will not be added in the sensitive data model as sensitive columns and \nif sensitive type OCIDs are assigned to the columns, then the sensitive type\nOCIDs will not be retained.\n" type: boolean parent: $ref: '#/components/schemas/ColumnsInfo' relationType: description: "The type of referential relationship the sensitive column has with its parent. \nDB_DEFINED indicates that the relationship is defined in the database dictionary. \nAPP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.\n" enum: - APP_DEFINED - DB_DEFINED type: string required: - relationType - parent - child type: object StartAuditTrailDetails: description: The details used to start an audit trail. properties: auditCollectionStartTime: description: The date from which the audit trail must start collecting data, in the format defined by RFC3339. format: date-time type: string canUpdateLastArchiveTimeOnTarget: default: true description: 'Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. ' type: boolean isAutoPurgeEnabled: default: false description: 'Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database''s audit trail does not become too large. ' type: boolean required: - auditCollectionStartTime type: object DatabaseViewAccessEntry: description: 'A DatabaseViewAccessEntry object is a resource corresponding to a row in view authorization report. It''s a subresource of Security Policy Report resource and is always associated with a SecurityPolicyReport. ' properties: accessType: description: 'The type of the access the user has on the table, there can be one or more from SELECT, UPDATE, INSERT or DELETE. ' enum: - SELECT - UPDATE - INSERT - DELETE - OWNER type: string x-obmcs-top-level-enum: '#/definitions/AccessType' columnName: description: If there are column level privileges on a table or view. maxLength: 255 minLength: 1 type: string grantFromRole: description: "This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the \nrole which is granted to the user though which the user has access to the table.\n" maxLength: 255 minLength: 1 type: string grantee: description: Grantee is the user who can access the table or view maxLength: 255 minLength: 1 type: string grantor: description: The user who granted the privilege. maxLength: 255 minLength: 1 type: string isAccessConstrainedByDatabaseVault: description: Indicates whether the table access is constrained via Oracle Database Vault. type: boolean isAccessConstrainedByRealApplicationSecurity: description: Indicates whether the view access is constrained via Real Application Security. type: boolean isAccessConstrainedByRedaction: description: Indicates whether the view access is constrained via Oracle Data Redaction. type: boolean isAccessConstrainedBySqlFirewall: description: Indicates whether the view access is constrained via Oracle Database SQL Firewall. type: boolean isAccessConstrainedByVirtualPrivateDatabase: description: Indicates whether the view access is constrained via Virtual Private Database. type: boolean key: description: The unique key that identifies the table access report. It is numeric and unique within a security policy report. maxLength: 255 minLength: 1 type: string privilege: description: The name of the privilege. enum: - SELECT - UPDATE - INSERT - DELETE - READ - OWNER - INDEX - SELECT_ANY_TABLE - UPDATE_ANY_TABLE - INSERT_ANY_TABLE - DELETE_ANY_TABLE - READ_ANY_TABLE - CREATE_ANY_INDEX type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeName' privilegeGrantable: description: "Indicates whether the grantee can grant this privilege to other users. Privileges can be granted to a user or role with \nGRANT_OPTION or ADMIN_OPTION\n" enum: - ADMIN_OPTION - GRANT_OPTION type: string x-obmcs-top-level-enum: '#/definitions/PrivilegeGrantableOption' privilegeType: description: 'Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. ' maxLength: 400 minLength: 1 type: string tableName: description: The name of the database table the user has access to. maxLength: 255 minLength: 1 type: string tableSchema: description: The name of the schema the table belongs to. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the of the target database. maxLength: 255 minLength: 1 type: string viewName: description: The name of the view. maxLength: 255 minLength: 1 type: string viewSchema: description: The name of the schema. maxLength: 255 minLength: 1 type: string viewText: description: Definition of the view. maxLength: 255 minLength: 1 type: string required: - key - grantee type: object MaskingPolicyHealthReportCollection: description: A collection of masking policy health report objects. properties: items: description: An array of masking policy health report objects. items: $ref: '#/components/schemas/MaskingPolicyHealthReportSummary' type: array required: - items type: object SensitiveColumnAnalyticsCollection: description: A collection of sensitive column analytics summary objects. properties: items: description: An array of sensitive column analytics summary objects. items: $ref: '#/components/schemas/SensitiveColumnAnalyticsSummary' type: array required: - items type: object Credentials: description: The database credentials required for Data Safe to connect to the database. properties: password: description: The password of the database user. format: password type: string userName: description: The database user name. maxLength: 512 minLength: 1 type: string required: - userName - password type: object MaskedColumnSummary: description: Summary of a masked column. A masked column is a database column masked by a data masking request. properties: columnName: description: The name of the masked column. maxLength: 128 minLength: 1 type: string key: description: The unique key that identifies the masked column. It's numeric and unique within a masking policy. maxLength: 255 minLength: 1 type: string maskingColumnGroup: description: The masking group of the masked column. maxLength: 255 minLength: 0 type: string maskingFormatUsed: description: The masking format used for masking the column. maxLength: 255 minLength: 1 type: string objectName: description: The name of the object (table or editioning view) that contains the masked column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the object (table or editioning view) that contains the masked column. enum: - TABLE - EDITIONING_VIEW type: string x-obmcs-top-level-enum: '#/definitions/ObjectType' parentColumnKey: description: The unique key that identifies the parent column of the masked column. maxLength: 255 minLength: 1 type: string schemaName: description: The name of the schema that contains the masked column. maxLength: 128 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the masked column. maxLength: 255 minLength: 1 type: string totalMaskedValues: description: The total number of values masked in the column. format: int64 type: integer required: - key - schemaName - objectName - objectType - columnName - maskingFormatUsed - totalMaskedValues type: object AuditPolicyCollection: description: Collection of audit policy summary. properties: items: description: Array of audit policy summary. items: $ref: '#/components/schemas/AuditPolicySummary' type: array required: - items type: object SelectionDetails: description: 'Details of the items to be selected and the mode of selection. ' discriminator: propertyName: selectionMode properties: selectionMode: description: 'The mode of selection of items, whether it is a list of ocids or a scimQuery. Allowed values: - LIST - SCIM_QUERY ' enum: - LIST - SCIM_QUERY type: string required: - selectionMode type: object UnifiedAuditPolicyConfig: description: 'The unified audit policy related configurations. ' properties: excludeDatasafeUser: description: Specifies whether the Data Safe service account on the target database should be excluded in the unified audit policy. enum: - ENABLED - DISABLED type: string required: - excludeDatasafeUser type: object AuditConditions: description: Represents audit policies with corresponding audit provisioning conditions. properties: auditPolicyName: description: 'Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. ' maxLength: 512 minLength: 1 type: string enableConditions: description: Indicates the users/roles in the target database for which the audit policy is enforced, and the success/failure event condition to generate the audit event.. items: $ref: '#/components/schemas/EnableConditions' type: array x-default-description: 'null' isDataSafeServiceAccountAudited: description: Indicates whether the Data Safe user activity on the target database will be audited by the policy. type: boolean isPrivUsersManagedByDataSafe: description: Indicates whether the privileged user list is managed by Data Safe. type: boolean required: - auditPolicyName - isPrivUsersManagedByDataSafe - isDataSafeServiceAccountAudited type: object ReportSummary: description: Description of report. properties: compartmentId: description: The OCID of the compartment containing the report. maxLength: 255 minLength: 1 type: string dataSource: description: Specifies the name of a resource that provides data for the report. For example alerts, events. enum: - EVENTS - ALERTS - VIOLATIONS - ALLOWED_SQL type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionDataSource' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the report. maxLength: 400 minLength: 1 type: string displayName: description: Name of the report. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the report. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the report. enum: - UPDATING - ACTIVE - CREATING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReportLifecycleState' mimeType: description: Specifies the format of report to be .xls or .pdf or .json. enum: - PDF - XLS - JSON type: string reportDefinitionId: description: The OCID of the report definition. maxLength: 255 minLength: 1 type: string timeCreated: description: Specifies the time at which the report was created. format: date-time type: string timeGenerated: description: Specifies the time at which the report was generated. format: date-time type: string timeUpdated: description: The date and time of the report update in Data Safe. format: date-time type: string type: description: The type of the report. enum: - GENERATED - SCHEDULED type: string x-obmcs-top-level-enum: '#/definitions/ReportType' required: - id - compartmentId - displayName - lifecycleState - timeGenerated type: object UpdateSensitiveTypeDetails: description: Details to update a sensitive type. discriminator: propertyName: entityType properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the sensitive type. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string entityType: description: 'The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. ' enum: - SENSITIVE_TYPE - SENSITIVE_CATEGORY type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeEntity' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object parentCategoryId: description: The OCID of the parent sensitive category. maxLength: 255 minLength: 1 type: string shortName: description: The short name of the sensitive type. maxLength: 128 minLength: 1 type: string required: - entityType type: object UnsetUserAssessmentBaselineDetails: description: The details required to unset the baseline of the assessment. properties: targetIds: description: The list of database target OCIDs for which the user intends to unset the baseline. items: maxLength: 255 minLength: 1 type: string maxItems: 1000 type: array type: object ChangeOnPremConnectorCompartmentDetails: description: The details used to change the compartment of a on-premises connector. properties: compartmentId: description: The OCID of the new compartment where you want to move the on-premises connector. maxLength: 100 minLength: 1 type: string required: - compartmentId TlsConfig: description: The details required to establish a TLS enabled connection. properties: certificateStoreType: description: The format of the certificate store. enum: - JKS type: string x-default-description: 'null' keyStoreContent: description: Base64 encoded string of key store file content. type: string x-default-description: 'null' status: description: Status to represent whether the database connection is TLS enabled or not. enum: - ENABLED - DISABLED type: string storePassword: description: The password to read the trust store and key store files, if they are password protected. format: password type: string x-default-description: 'null' trustStoreContent: description: Base64 encoded string of trust store file content. type: string required: - status type: object ChangeAlertCompartmentDetails: description: The details used to change the compartment of an alert. properties: compartmentId: description: The OCID of the new compartment to move the alert to. maxLength: 100 minLength: 1 type: string required: - compartmentId SecurityPolicyDeploymentSummary: description: 'The resource represents the state of the deployment of a security policy on a target. ' properties: compartmentId: description: The OCID of the compartment containing the security policy deployment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy deployment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the security policy deployment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security policy deployment. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the security policy deployment in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the security policy deployment. enum: - CREATING - UPDATING - DEPLOYED - PENDING_DEPLOYMENT - NEEDS_ATTENTION - FAILED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/SecurityPolicyDeploymentLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetId: description: The OCID of the target/target group where the security policy is deployed. maxLength: 255 minLength: 1 type: string targetType: description: Indicates whether the security policy deployment is for a target database or a target database group. type: string x-obmcs-enumref: '#/definitions/SecurityPolicyDeployment/targetType' timeCreated: description: The time that the security policy deployment was created, in the format defined by RFC3339. format: date-time type: string timeDeployed: description: The last date and time the security policy was deployed, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the security policy deployment was updated, in the format defined by RFC3339. format: date-time type: string required: - id - displayName - targetId - securityPolicyId - compartmentId - timeCreated - lifecycleState type: object SecurityPolicyDeploymentCollection: description: Collection of security policy deployment summary. properties: items: description: Array of security policy deployment summary. items: $ref: '#/components/schemas/SecurityPolicyDeploymentSummary' type: array required: - items type: object SqlFirewallPolicyAnalyticsCollection: description: SQL Firewall policy analytics collection. properties: items: description: The aggregated data point items. items: $ref: '#/components/schemas/SqlFirewallPolicyAggregation' type: array required: - items type: object column: description: The description of the column. properties: applicableOperators: description: An array of operators that can be supported by column fieldName. items: enum: - IN - EQ - EQ_CS - GT - GE - LT - LE - AND - OR - NE - CO - CO_CS - NOT - NOT_IN - IN_SET - NOT_IN_SET type: string maxItems: 30 type: array dataType: description: Specifies the data type of the column. maxLength: 255 minLength: 1 type: string displayName: description: Name of the column displayed on UI. maxLength: 255 minLength: 1 type: string displayOrder: description: Specifies the display order of the column. format: int32 type: integer fieldName: description: Specifies the corresponding field name in the data source. maxLength: 255 minLength: 1 type: string isHidden: default: true description: Indicates if the column is hidden. Values can either be 'true' or 'false'. type: boolean isVirtual: default: false description: Specifies if column is virtual and can only be used as column filter. type: boolean required: - displayName - fieldName - isHidden - displayOrder type: object ModifyGlobalSettingsDetails: description: The details required to modify the global settings in Data Safe. properties: isPaidUsage: default: false description: The paid usage option chosen by the customer admin. type: boolean offlineRetentionPeriod: default: 12 description: The offline retention period in months. type: integer onlineRetentionPeriod: default: 12 description: The online retention period in months. type: integer type: object UpdatePeerTargetDatabaseDetails: description: The details of the peer database used for updating the peer target database in Data Safe. properties: databaseDetails: $ref: '#/components/schemas/DatabaseDetails' description: description: The description of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the peer target database in Data Safe. maxLength: 255 minLength: 1 type: string tlsConfig: $ref: '#/components/schemas/TlsConfig' type: object ManagePrivilegesDetails: description: The details used to manage the features of a Data Safe target database. properties: features: description: The Data Safe features granted to the databases registering under the registration policy. items: enum: - ASSESSMENT - AUDIT_COLLECTION - AUDIT_SETTING - DATA_DISCOVERY - MASKING - SQL_FIREWALL - ALL type: string type: array uniqueItems: true required: - features SqlFirewallAllowedSql: description: 'The resource represents a SQL Firewall allowed SQL in Data Safe. ' properties: compartmentId: description: The OCID of the compartment containing the SQL Firewall allowed SQL. maxLength: 100 minLength: 1 type: string currentUser: description: The name of the user that SQL was executed as. maxLength: 512 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Firewall allowed SQL. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the SQL Firewall allowed SQL. enum: - ACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallAllowedSqlLifecycleState' sqlAccessedObjects: description: The objects accessed by the SQL. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array sqlFirewallPolicyId: description: The OCID of the SQL Firewall policy corresponding to the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string sqlText: description: The SQL text of the SQL Firewall allowed SQL. maxLength: 32767 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCollected: description: The time the the SQL Firewall allowed SQL was collected from the target database, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the SQL Firewall allowed SQL was updated, in the format defined by RFC3339. format: date-time type: string version: description: Version of the associated SQL Firewall policy. This identifies whether the allowed SQLs were added in the same batch or not. format: float type: number required: - id - displayName - compartmentId - sqlFirewallPolicyId - dbUserName - sqlText - sqlLevel - timeCollected - lifecycleState - version type: object SensitiveColumn: description: 'A sensitive column is a resource corresponding to a database column that is considered sensitive. It''s a subresource of sensitive data model resource and is always associated with a sensitive data model. Note that referential relationships are also managed as part of sensitive columns. ' properties: appDefinedChildColumnKeys: description: Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array appName: description: 'The name of the application associated with the sensitive column. It''s useful when the application name is different from the schema name. Otherwise, it can be ignored. ' maxLength: 128 minLength: 1 type: string columnGroups: description: 'The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it''s assigned a column group. It helps identify and manage referential relationships that involve composite keys. ' items: maxLength: 255 minLength: 1 type: string type: array columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string dataType: description: The data type of the sensitive column. maxLength: 128 minLength: 1 type: string dbDefinedChildColumnKeys: description: Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. items: maxLength: 255 minLength: 1 type: string type: array estimatedDataValueCount: description: The estimated number of data values the column has in the associated database. format: int64 type: integer key: description: The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the sensitive column. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the sensitive column. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SensitiveColumnLifecycleState' objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string objectType: description: The type of the database object that contains the sensitive column. enum: - TABLE - EDITIONING_VIEW type: string parentColumnKeys: description: Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. items: maxLength: 255 minLength: 1 type: string type: array relationType: description: 'The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. ' enum: - NONE - APP_DEFINED - DB_DEFINED type: string sampleDataValues: description: 'Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. ' items: maxLength: 4000 minLength: 1 type: string type: array schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveDataModelId: description: The OCID of the sensitive data model that contains the sensitive column. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the sensitive column. maxLength: 255 minLength: 1 type: string source: description: 'The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually. ' enum: - MANUAL - DISCOVERY type: string status: description: 'The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again. ' enum: - VALID - INVALID type: string timeCreated: description: 'The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was created in the sensitive data model. ' format: date-time type: string timeUpdated: description: 'The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was last updated in the sensitive data model. ' format: date-time type: string required: - key - sensitiveDataModelId - timeCreated - timeUpdated - lifecycleState - appName - schemaName - objectName - columnName - objectType - dataType - status - source - relationType - estimatedDataValueCount type: object SensitiveColumnAnalyticsDimensions: description: The dimensions available for sensitive column analytics. properties: columnName: description: The name of the sensitive column. maxLength: 128 minLength: 1 type: string objectName: description: The database object that contains the sensitive column. maxLength: 128 minLength: 1 type: string schemaName: description: The database schema that contains the sensitive column. maxLength: 128 minLength: 1 type: string sensitiveDataModelId: description: The OCID of the sensitive data model which contains the sensitive column. maxLength: 255 minLength: 1 type: string sensitiveTypeId: description: The OCID of the sensitive type associated with the sensitive column. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target database associated with the sensitive column. maxLength: 255 minLength: 1 type: string type: object ChangeAuditProfileCompartmentDetails: description: Moves the specified audit profile and its assoicated resources into a different compartment. properties: compartmentId: description: 'The OCID of the compartment where you want to move the audit profile. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateTargetAlertPolicyAssociationDetails: description: 'The details used to update a target-alert policy association. ' properties: definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Describes the target-alert policy association. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the target-alert policy association. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Indicates if the target-alert policy association is enabled or disabled by user. type: boolean type: object ApplySdmMaskingPolicyDifferenceDetails: description: Details to apply the SDM masking policy difference to a masking policy. properties: sdmMaskingPolicyDifferenceId: description: The OCID of the SDM masking policy difference. maxLength: 255 minLength: 1 type: string required: - sdmMaskingPolicyDifferenceId type: object DiscoveryAnalyticsCollection: description: A collection of discovery analytics summary objects. properties: items: description: An array of discovery analytics summary objects. items: $ref: '#/components/schemas/DiscoveryAnalyticsSummary' type: array required: - items type: object CreateSecurityPolicyDeploymentDetails: description: Details to create the security policy deployment. properties: compartmentId: description: The OCID of the compartment in which to create the unified audit policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the security policy. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the security policy deployment. The name does not have to be unique, and it is changeable. maxLength: 255 minLength: 1 type: string x-default-description: This field will be set to a value in the format SecurityPolicyDeployment freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object securityPolicyId: description: The OCID of the security policy corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string targetId: description: The OCID of the target where the security policy is deployed. maxLength: 255 minLength: 1 type: string targetType: description: Indicates whether the security policy deployment is for a target database or a target database group. type: string x-obmcs-enumref: '#/definitions/SecurityPolicyDeployment/targetType' required: - compartmentId - targetId - targetType - securityPolicyId type: object Include: description: 'Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, definedTags, freeformTagsIn or systemTags criteria then it qualifies for inclusion in the target database group. ' properties: compartments: description: List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group. items: $ref: '#/components/schemas/Compartments' maxItems: 100 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object freeformTagsIn: additionalProperties: type: object description: Map of freeform tag filters. Each key maps to an array of strings. Target database matches the key if it's tag value equals any of the values in the array. type: object systemTags: additionalProperties: additionalProperties: type: object type: object description: Map of system tag filters. Target database matches when for each specified namespace.key and the tag value equals any of the values in the array. type: object targetDatabaseIds: description: The list of target database OCIDs to be included in the target database group. items: maxLength: 255 minLength: 1 type: string maxItems: 100 minItems: 0 type: array uniqueItems: true type: object GrantSummary: description: The summary of user grants. properties: depthLevel: description: 'The grant depth level of the indirect grant. An indirectly granted role/privilege is granted to the user through another role. The depth level indicates how deep a privilege is within the grant hierarchy. ' format: int32 type: integer grantName: description: The name of a user grant. maxLength: 255 minLength: 1 type: string key: description: The unique key of a user grant. maxLength: 255 minLength: 1 type: string privilegeCategory: description: The privilege category. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string privilegeType: description: The type of a user grant. enum: - SYSTEM_PRIVILEGE - OBJECT_PRIVILEGE - ADMIN_PRIVILEGE - ROLE type: string required: - key type: object AuditTrailCollection: description: Collection of audit trail detail objects. properties: items: description: Array of audit trail summary. items: $ref: '#/components/schemas/AuditTrailSummary' type: array required: - items type: object GenerateOnPremConnectorConfigurationDetails: description: The details used to create and download on-premises connector's configuration. properties: password: description: The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. maxLength: 30 minLength: 12 type: string required: - password GroupedSensitiveTypeSummary: description: Id of sensitive types present in a sensitive type group. properties: sensitiveTypeId: description: The OCID of the sensitive type. maxLength: 255 minLength: 1 type: string required: - sensitiveTypeId type: object PatchSensitiveColumnDetails: description: Details to patch columns in a sensitive data model. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object DiscoveryJobResultCollection: description: A collection of discovery job result summary objects. properties: items: description: An array of discovery job result summary objects. items: $ref: '#/components/schemas/DiscoveryJobResultSummary' type: array required: - items type: object PatchMaskingColumnsDetails: description: Details to patch columns in a masking policy. properties: items: description: An array of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' maxItems: 1000 type: array type: object TemplateBaselineDiffsPerTarget: description: 'The results of the comparison between two security assessment resources, and one of them is TEMPLATE_BASELINE type. ' properties: key: description: A unique identifier for the finding. This is common for the finding across targets. maxLength: 255 minLength: 1 type: string severity: description: The severity of this diff. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string title: description: The short title for the finding. maxLength: 255 minLength: 1 type: string type: object SqlFirewallAllowedSqlSummary: description: 'The resource represents a SQL Firewall allowed SQL in Data Safe. ' properties: compartmentId: description: The OCID of the compartment containing the SQL Firewall allowed SQL. maxLength: 100 minLength: 1 type: string currentUser: description: The name of the user that SQL was executed as. maxLength: 512 minLength: 1 type: string dbUserName: description: The database user name. maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Firewall allowed SQL. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the SQL Firewall allowed SQL. enum: - ACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/SqlFirewallAllowedSqlLifecycleState' sqlAccessedObjects: description: The objects accessed by the SQL. items: maxLength: 512 minLength: 1 type: string maxItems: 1000 type: array sqlFirewallPolicyId: description: The OCID of the SQL Firewall policy corresponding to the SQL Firewall allowed SQL. maxLength: 255 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string sqlText: description: The SQL text of the SQL Firewall allowed SQL. maxLength: 32767 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCollected: description: The time the the SQL Firewall allowed SQL was collected from the target database, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the SQL Firewall allowed SQL was updated, in the format defined by RFC3339. format: date-time type: string version: description: Version of the associated SQL Firewall policy. This identifies whether the allowed SQLs were added in the same batch or not. format: float type: number required: - id - displayName - compartmentId - sqlFirewallPolicyId - dbUserName - sqlText - sqlLevel - timeCollected - lifecycleState - version type: object ChangeDiscoveryJobCompartmentDetails: description: Details to change the compartment of a discovery job resource. properties: compartmentId: description: The OCID of the compartment where the discovery job should be moved. maxLength: 100 minLength: 1 type: string required: - compartmentId type: object UnifiedAuditPolicySummary: description: 'Resource represents a single unified audit policy on the target database. ' properties: compartmentId: description: The OCID of the compartment containing the unified audit policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the unified audit policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the unified audit policy. maxLength: 255 minLength: 1 type: string enabledEntities: description: Indicates the users for which the unified audit policy is enabled. type: string x-obmcs-enumref: '#/definitions/UnifiedAuditPolicy/enabledEntities' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the unified audit policy. maxLength: 255 minLength: 1 type: string isSeeded: description: Signifies whether the unified audit policy is seeded or not. type: boolean lifecycleDetails: description: The details of the current state of the unified audit policy in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the unified audit policy. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION - DELETED type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyLifecycleState' securityPolicyId: description: The OCID of the security policy corresponding to the unified audit policy. maxLength: 255 minLength: 1 type: string status: description: Indicates whether the policy has been enabled or disabled. type: string x-obmcs-enumref: '#/definitions/UnifiedAuditPolicy/status' systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the unified audit policy was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The last date and time the unified audit policy was updated, in the format defined by RFC3339. format: date-time type: string unifiedAuditPolicyDefinitionId: description: The OCID of the associated unified audit policy definition. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState type: object UpdateMaskingPolicyDetails: description: Details to update a masking policy. properties: columnSource: $ref: '#/components/schemas/UpdateColumnSourceDetails' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the masking policy. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object isDropTempTablesEnabled: description: "Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default.\nSet this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive \ndata values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want \nto preserve this information to track how masking changed your data. Note that doing so compromises security. These tables \nmust be dropped before the database is available for unprivileged users. \n" type: boolean isRedoLoggingEnabled: description: "Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to\nenable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked \ndata from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking,\nyou could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. \n" type: boolean isRefreshStatsEnabled: description: 'Indicates if statistics gathering is enabled. It''s enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes. ' type: boolean parallelDegree: description: 'Specifies options to enable parallel execution when running data masking. Allowed values are ''NONE'' (no parallelism), ''DEFAULT'' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. ' type: string postMaskingScript: description: 'A post-masking script, which can contain SQL and PL/SQL statements. It''s executed after the core masking script generated using the masking policy. It''s usually used to perform additional transformation or cleanup work after masking. ' type: string preMaskingScript: description: "A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before \nthe core masking script generated using the masking policy. It's usually used to perform\nany preparation or prerequisite work before masking data.\n" type: string recompile: description: "Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), \n'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree\nattribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.\n" type: string x-obmcs-enumref: '#/definitions/MaskingPolicy/recompile' type: object CreateLibraryMaskingFormatDetails: description: "Details to create a library masking format, which can have one or more format entries. A format \nentry can be a basic masking format such as Random Number, or it can be a library masking format. \nThe combined output of all the format entries is used for masking. It provides the flexibility \nto define a masking format that can generate different parts of a data value separately and then \ncombine them to get the final data value for masking. Note that you cannot define masking \ncondition in a library masking format. \n" properties: compartmentId: description: The OCID of the compartment where the library masking format should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the library masking format. maxLength: 400 minLength: 1 type: string x-default-description: The description is set to null by default. displayName: description: The display name of the library masking format. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: It will be set to a value in the format LibraryMaskingFormat_ formatEntries: description: An array of format entries. The combined output of all the format entries is used for masking. items: $ref: '#/components/schemas/FormatEntry' maxItems: 100 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object sensitiveTypeIds: description: 'An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created. ' items: maxLength: 255 minLength: 1 type: string type: array required: - compartmentId - formatEntries type: object SdmMaskingPolicyDifferenceSummary: description: Summary of a SDM masking policy difference. properties: compartmentId: description: The OCID of the compartment to contain the SDM masking policy difference. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object differenceType: description: The type of difference. type: string x-obmcs-enumref: '#/definitions/SdmMaskingPolicyDifference/differenceType' displayName: description: The display name of the SDM masking policy difference. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the SDM masking policy difference. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the SDM masking policy difference. type: string x-obmcs-enumref: '#/definitions/SdmMaskingPolicyDifference/lifecycleState' maskingPolicyId: description: The OCID of the masking policy associated with the SDM masking policy difference. maxLength: 255 minLength: 1 type: string sensitiveDataModelId: description: The OCID of the sensitive data model associated with the SDM masking policy difference. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the SDM masking policy difference was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeCreationStarted: description: The date and time the SDM masking policy difference creation started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeCreationStarted - sensitiveDataModelId - maskingPolicyId - lifecycleState - differenceType type: object AlertPolicyRuleSummary: description: A rule associated with an alert policy. properties: description: description: Describes the alert policy rule. maxLength: 400 minLength: 1 type: string expression: description: The conditional expression of the alert policy rule which evaluates to boolean value. minLength: 1 type: string key: description: The unique key of the alert policy rule. maxLength: 100 minLength: 1 type: string required: - key - expression GenerateMaskingReportForDownloadDetails: description: Details to generate a downloadable masking report. properties: reportFormat: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string reportId: description: The OCID of the masking report for which a downloadable file is to be generated. maxLength: 255 minLength: 1 type: string required: - reportId - reportFormat type: object PeerTargetDatabase: description: The details of the peer target database in Data Safe. properties: databaseDetails: $ref: '#/components/schemas/DatabaseDetails' databaseUniqueName: description: Unique name of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string dataguardAssociationId: description: The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. maxLength: 255 minLength: 1 type: string description: description: The description of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the peer target database in Data Safe. maxLength: 255 minLength: 1 type: string key: description: The secondary key assigned for the peer target database in Data Safe. type: integer lifecycleDetails: description: Details about the current state of the peer target database in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the peer target database in Data Safe. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/TargetDatabaseLifecycleState' role: description: Role of the database associated to the peer target database. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time of the peer target database registration in Data Safe. format: date-time type: string tlsConfig: $ref: '#/components/schemas/TlsConfig' required: - key - displayName - dataguardAssociationId - databaseDetails - lifecycleState - timeCreated type: object SqlFirewallViolationSummary: description: The resource represents the SQL violations collected from the target database by Oracle Data Safe. properties: clientIp: description: The IP address of the host machine from which the session was generated. maxLength: 255 minLength: 1 type: string clientOsUserName: description: The name of the operating system user for the database session. maxLength: 1024 minLength: 1 type: string clientProgram: description: The application from which the SQL violation was generated. Examples include SQL Plus or SQL Developer. maxLength: 512 minLength: 1 type: string compartmentId: description: The OCID of the compartment containing the SQL violation. maxLength: 100 minLength: 1 type: string currentDbUserName: description: The name of the user that SQL was executed as. maxLength: 255 minLength: 1 type: string dbUserName: description: The name of the database user. maxLength: 1024 minLength: 1 type: string id: description: The OCID of the SQL violation. maxLength: 255 minLength: 1 type: string operation: description: The name of the action executed by the user on the target database. For example, ALTER, CREATE, DROP. maxLength: 255 minLength: 1 type: string operationTime: description: The time of the SQL violation occurrence in the target database. format: date-time type: string sqlAccessedObjects: description: The objects accessed by the SQL. maxLength: 32767 minLength: 1 type: string sqlLevel: description: 'Specifies the level of SQL for this violation. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. ' enum: - USER_ISSUED_SQL - ALL_SQL type: string sqlText: description: The SQL text caught by the firewall. maxLength: 32767 minLength: 1 type: string targetId: description: The OCID of the target database. maxLength: 255 minLength: 1 type: string targetName: description: The name of the target database. maxLength: 255 minLength: 1 type: string timeCollected: description: The timestamp when this SQL violation was collected from the target database by Data Safe. format: date-time type: string violationAction: description: The action taken for this SQL violation. enum: - BLOCKED - ALLOWED type: string violationCause: description: Indicates whether SQL or context violation. maxLength: 30 minLength: 1 type: string required: - id - compartmentId - targetId - targetName - operationTime - timeCollected - violationAction type: object SecurityAssessmentComparison: description: 'Provides a list of the differences in a comparison of the security assessment with the baseline value. ' properties: baselineId: description: The OCID of the security assessment that is set as a baseline. maxLength: 255 minLength: 1 type: string id: description: The OCID of the security assessment that is being compared with a baseline security assessment. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the security assessment comparison. enum: - CREATING - SUCCEEDED - FAILED - DELETED - DELETING type: string targets: description: A target-based comparison between two security assessments. items: $ref: '#/components/schemas/SecurityAssessmentComparisonPerTarget' maxItems: 1000 type: array timeCreated: description: The date and time when the security assessment comparison was created. Conforms to the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string required: - lifecycleState - timeCreated type: object ReportCollection: description: Collection of report summary. properties: items: description: Array of report summary. items: $ref: '#/components/schemas/ReportSummary' type: array required: - items type: object UpdateAttributeSetDetails: description: Details to update an attribute set. properties: attributeSetValues: description: The list of attribute set values that will replace existing values. items: maxLength: 256 minLength: 1 type: string maxItems: 1000 type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of an attribute set. maxLength: 400 minLength: 1 type: string displayName: description: The display name of an attribute set. The name does not have to be unique, and is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object type: object AuditPolicyDimensions: description: Details of aggregation dimensions used for summarizing audit policies. properties: auditPolicyCategory: description: The category to which the audit policy belongs. enum: - BASIC_ACTIVITY - ADMIN_USER_ACTIVITY - USER_ACTIVITY - ORACLE_PREDEFINED - COMPLIANCE_STANDARD - CUSTOM - SQL_FIREWALL_AUDITING type: string x-obmcs-top-level-enum: '#/definitions/AuditPolicyCategory' auditPolicyName: description: 'The name of the audit policy. Refer to the [documentation](https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/data-safe&id=UDSCS-GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. ' maxLength: 512 minLength: 1 type: string targetId: description: The OCID of the target database for which the audit policy will be created. maxLength: 255 minLength: 1 type: string type: object ProvisionAuditPolicyDetails: description: Details for audit policy provisioning. properties: isDataSafeServiceAccountExcluded: default: false description: Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies. type: boolean provisionAuditConditions: description: The audit policy details for provisioning. items: $ref: '#/components/schemas/ProvisionAuditConditions' type: array required: - provisionAuditConditions type: object AuditProfileSummary: description: Summary of an audit profile. properties: auditCollectedVolume: description: "Number of audit records collected in the current calendar month. \nAudit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.\n" format: int64 type: integer compartmentId: description: The OCID of the compartment that contains the audit profile. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the audit profile. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the audit profile. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the audit profile. maxLength: 255 minLength: 1 type: string isOverrideGlobalPaidUsage: description: 'Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see [Data Safe Price List](https://www.oracle.com/cloud/price-list/#data-safe). ' type: boolean isOverrideGlobalRetentionSetting: description: 'Indicates whether audit retention settings like online and offline months set at the target level override the global or target database group level audit retention settings. ' type: boolean isPaidUsageEnabled: description: "Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database,\npotentially incurring additional charges. The default value is inherited from the global settings. \nYou can change at the global level or at the target level.\n" type: boolean lifecycleDetails: description: Details about the current state of the audit profile in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit profile. enum: - CREATING - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION - DELETED type: string x-obmcs-top-level-enum: '#/definitions/AuditProfileLifecycleState' offlineMonths: description: 'Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support. ' format: int32 minimum: 0 type: integer onlineMonths: description: 'Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months ' format: int32 maximum: 12 minimum: 1 type: integer targetId: description: The OCID of the target database for which the audit profile is created. maxLength: 255 minLength: 1 type: string targetType: description: The resource type that is represented by the audit profile. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/AuditProfileTargetType' timeCreated: description: The date and time the audit profile was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the audit profile was updated, in the format defined by RFC3339. format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - targetId - timeCreated - timeUpdated - isPaidUsageEnabled - onlineMonths - offlineMonths - isOverrideGlobalRetentionSetting type: object SqlFirewallPolicyAggregation: description: The details of SQL Firewall policy. properties: count: description: The total count of the aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/SqlFirewallPolicyDimensions' required: - dimensions - count type: object SqlFirewallAllowedSqlAggregation: description: The details of SQL Firewall allow SQL aggregate. properties: count: description: The total count of the aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/SqlFirewallAllowedSqlDimensions' required: - dimensions - count type: object SqlFirewallViolationAggregation: description: The details of SQL violations aggregation items. properties: count: description: Total count of aggregated value. format: int64 type: integer dimensions: $ref: '#/components/schemas/SqlFirewallViolationAggregationDimensions' displayName: description: The display name of aggregation field. maxLength: 128 minLength: 0 type: string metricName: description: The name of the aggregation. maxLength: 128 minLength: 0 type: string timeEnded: description: The time at which the aggregation ended. format: date-time type: string timeStarted: description: The time at which the aggregation started. format: date-time type: string required: - metricName - timeStarted - timeEnded - count type: object SqlCollectionDimensions: description: The dimensions available for SQL collection analytics. properties: lifecycleState: description: The current state of the SQL collection. enum: - CREATING - UPDATING - COLLECTING - COMPLETED - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlCollectionLifecycleState' targetId: description: The OCID of the target corresponding to the security policy deployment. maxLength: 255 minLength: 1 type: string type: object AttributeSetCollection: description: Collection of attribute sets. properties: items: description: Array of attribute sets. items: $ref: '#/components/schemas/AttributeSetSummary' maxItems: 100 type: array required: - items type: object SecurityFeatureAnalyticsDimensions: description: The scope of analytics data. properties: securityFeature: description: The name of the security feature. enum: - UNIFIED_AUDIT - FINE_GRAINED_AUDIT - TRADITIONAL_AUDIT - DATABASE_VAULT - PRIVILEGE_ANALYSIS - TABLESPACE_ENCRYPTION - COLUMN_ENCRYPTION - NETWORK_ENCRYPTION - PASSWORD_AUTHENTICATION - GLOBAL_AUTHENTICATION - EXTERNAL_AUTHENTICATION type: string type: object Report: description: The description of the report. properties: compartmentId: description: The OCID of the compartment containing the report. maxLength: 255 minLength: 1 type: string dataSource: description: Specifies the name of a resource that provides data for the report. For example alerts, events. enum: - EVENTS - ALERTS - VIOLATIONS - ALLOWED_SQL type: string x-obmcs-top-level-enum: '#/definitions/ReportDefinitionDataSource' definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Specifies a description of the report. maxLength: 400 minLength: 1 type: string displayName: description: Name of the report. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the report. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the report in Data Safe. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the audit report. enum: - UPDATING - ACTIVE - CREATING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ReportLifecycleState' mimeType: description: Specifies the format of report to be .xls or .pdf or .json enum: - PDF - XLS - JSON type: string nextReportId: description: The OCID of the next report generated. maxLength: 255 minLength: 1 type: string previousReportId: description: The OCID of the previous report generated. maxLength: 255 minLength: 1 type: string reportDefinitionId: description: The OCID of the report definition. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Specifies the time at which the report was created. format: date-time type: string timeGenerated: description: Specifies the date and time the report was generated. format: date-time type: string timeUpdated: description: The date and time of the report update in Data Safe. format: date-time type: string type: description: The type of the audit report. enum: - GENERATED - SCHEDULED type: string x-obmcs-top-level-enum: '#/definitions/ReportType' required: - id - compartmentId - displayName - lifecycleState - timeGenerated type: object CheckSummary: description: The summary of the security rule to be evaluated by security assessment to create finding. properties: category: description: The category to which the check belongs to. type: string key: description: A unique identifier for the check. type: string oneline: description: Provides a recommended approach to take to remediate the check reported. type: string references: $ref: '#/components/schemas/References' description: Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice. remarks: description: The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. type: string suggestedSeverity: description: The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment. enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string title: description: The short title for the check. type: string required: - key - title type: object columnSorting: description: Sorts the data at the column level. properties: fieldName: description: Name of the column that must be sorted. maxLength: 255 minLength: 1 type: string isAscending: description: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'. type: boolean sortingOrder: description: Indicates the order at which column must be sorted. format: int32 type: integer required: - fieldName - isAscending - sortingOrder type: object GenerateSensitiveDataModelForDownloadDetails: description: Details to generate a downloadable sensitive data model. properties: dataModelFormat: default: XML description: The format of the sensitive data model file. enum: - XML type: string x-obmcs-top-level-enum: '#/definitions/DataModelFormat' type: object MaskingPolicySummary: description: Summary of a masking policy. properties: columnSource: $ref: '#/components/schemas/ColumnSourceDetails' compartmentId: description: The OCID of the compartment that contains the masking policy. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the masking policy. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the masking policy. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the masking policy. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the masking policy. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' timeCreated: description: "The date and time the masking policy was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string timeUpdated: description: "The date and time the masking policy was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). \n" format: date-time type: string required: - id - compartmentId - displayName - timeCreated - timeUpdated - lifecycleState type: object SecurityPolicyReportCollection: description: Collection of security policy report summary. properties: items: description: Array of security policy report summary. items: $ref: '#/components/schemas/SecurityPolicyReportSummary' type: array required: - items type: object PatchInstruction: description: A single instruction to be included as part of Patch request content. discriminator: propertyName: operation properties: operation: description: The patch operation. enum: - INSERT - REMOVE - MERGE type: string selection: description: The set of values to which the operation applies as a [JMESPath expression](https://jmespath.org/specification.html) for evaluation against the context resource. An operation fails if the selection yields an exception, except as otherwise specified. Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false. type: string required: - operation - selection ChangeSensitiveTypeGroupCompartmentDetails: description: Details for which compartment to move the resource to. properties: compartmentId: description: The OCID of the compartment where you want to move the sensitive type group. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object TemplateAssociationAnalyticsSummary: description: The summary of template association analytics data. properties: count: description: The total count for the aggregation metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/TemplateAssociationAnalyticsDimensions' metricName: description: The name of the aggregation metric. enum: - TEMPLATE_ASSOCIATION_STATS type: string required: - metricName - count type: object TemplateBaselineDiffs: description: 'Results of the comparison of an item between two security assessments. ' properties: baseline: $ref: '#/components/schemas/Finding' targets: description: A target-based comparison between two security assessments. items: $ref: '#/components/schemas/TemplateBaselineDiffsPerTarget' maxItems: 1000 type: array type: object MaskingReportSummary: description: Summary of a masking report. properties: compartmentId: description: The OCID of the compartment that contains the masking report. maxLength: 100 minLength: 1 type: string id: description: The OCID of the masking report. maxLength: 255 minLength: 1 type: string isDropTempTablesEnabled: description: 'Indicates if the temporary tables created during the masking operation were dropped after masking. ' type: boolean isRedoLoggingEnabled: description: 'Indicates if redo logging was enabled during the masking operation. ' type: boolean isRefreshStatsEnabled: description: 'Indicates if statistics gathering was enabled during the masking operation. ' type: boolean lifecycleState: description: The current state of the masking report. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' maskingPolicyId: description: The OCID of the masking policy used. maxLength: 255 minLength: 1 type: string maskingStatus: description: The status of the masking job. enum: - FAILED - SUCCESS type: string maskingWorkRequestId: description: The OCID of the masking work request that resulted in this masking report. maxLength: 255 minLength: 1 type: string parallelDegree: description: 'Indicates if parallel execution was enabled during the masking operation. ' type: string recompile: description: 'Indicates how invalid objects were recompiled post the masking operation. ' type: string targetId: description: The OCID of the target database masked. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the masking report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeMaskingFinished: description: The date and time data masking finished, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string timeMaskingStarted: description: The date and time data masking started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string totalMaskedColumns: description: The total number of masked columns. format: int64 type: integer totalMaskedObjects: description: The total number of unique objects (tables and editioning views) that contain the masked columns. format: int64 type: integer totalMaskedSchemas: description: The total number of unique schemas that contain the masked columns. format: int64 type: integer totalMaskedSensitiveTypes: description: The total number of unique sensitive types associated with the masked columns. format: int64 type: integer totalMaskedValues: description: The total number of masked values. format: int64 type: integer totalPostMaskingScriptErrors: description: The total number of errors in post-masking script. format: int64 type: integer totalPreMaskingScriptErrors: description: The total number of errors in pre-masking script. format: int64 type: integer required: - id - compartmentId - lifecycleState - maskingWorkRequestId - maskingPolicyId - targetId - totalMaskedSensitiveTypes - totalMaskedSchemas - totalMaskedObjects - totalMaskedColumns - totalMaskedValues - timeMaskingStarted - timeMaskingFinished - maskingStatus type: object AuditProfileAggregationItems: description: Details of audit profile aggregation items. properties: count: description: Total count of aggregated metric. format: int64 type: integer dimensions: $ref: '#/components/schemas/AuditProfileDimensions' type: object CreateSensitiveTypeDetails: description: Details to create a new sensitive type. discriminator: propertyName: entityType properties: compartmentId: description: The OCID of the compartment where the sensitive type should be created. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the sensitive type. maxLength: 400 minLength: 1 type: string x-default-description: 'null' displayName: description: The display name of the sensitive type. The name does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string x-default-description: SensitiveType_ entityType: description: 'The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. ' enum: - SENSITIVE_TYPE - SENSITIVE_CATEGORY type: string x-obmcs-top-level-enum: '#/definitions/SensitiveTypeEntity' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object parentCategoryId: description: The OCID of the parent sensitive category. maxLength: 255 minLength: 1 type: string shortName: description: The short name of the sensitive type. maxLength: 128 minLength: 1 type: string x-default-description: 'null' required: - compartmentId - entityType type: object UserAssessment: description: The details of the user assessment, which includes statistics related to target database users. properties: compartmentId: description: The OCID of the compartment that contains the user assessment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the user assessment. maxLength: 400 minLength: 1 type: string displayName: description: The display name of the user assessment. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the user assessment. maxLength: 255 minLength: 1 type: string ignoredAssessmentIds: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array ignoredTargets: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array isBaseline: description: Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments. type: boolean isDeviatedFromBaseline: description: Indicates if the user assessment deviates from the baseline. type: boolean lastComparedBaselineId: description: The OCID of the last user assessment baseline against which the latest assessment was compared. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Details about the current state of the user assessment. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current state of the user assessment. enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/UserAssessmentLifecycleState' schedule: description: "Schedule of the assessment that runs periodically in this specified format:\n ;\n\n Allowed version strings - \"v1\"\n v1's version specific schedule - \n Each of the above fields potentially introduce constraints. A workrequest is created only\n when clock time satisfies all the constraints. Constraints introduced:\n 1. seconds = (So, the allowed range for is [0, 59])\n 2. minutes = (So, the allowed range for is [0, 59])\n 3. hours = (So, the allowed range for is [0, 23])\n can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday))\n 4. No constraint introduced when it is '*'. When not, day of week must equal the given value\n can be either '*' (without quotes or a number between 1 and 28)\n 5. No constraint introduced when it is '*'. When not, day of month must equal the given value\n" example: '1. "0 30 13 * *" - This indicates to run a user assessment at 13:30:00 every day 2. "0 30 13 2 *" - This indicates to run a user assessment at 13:30:00 every Tuesday 3. "0 30 1 * 3" - This indicates to run a user assessment at 13:30:00 on 3rd of every month ' maxLength: 50 minLength: 1 type: string scheduleAssessmentId: description: The OCID of the user assessment that is responsible for creating this scheduled save assessment. maxLength: 255 minLength: 1 type: string statistics: additionalProperties: additionalProperties: description: 'Value of the map as key-pair values. Example: `{"critical": "users"}` ' type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object description: "Map that contains maps of values.\n Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n" type: object systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseGroupId: description: The OCID of target database group. maxLength: 255 minLength: 1 type: string targetIds: description: Array of database target OCIDs. items: maxLength: 255 minLength: 1 type: string type: array targetType: description: Indicates whether the user assessment is for a target database or a target database group. enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP type: string x-obmcs-top-level-enum: '#/definitions/UserAssessmentTargetType' timeCreated: description: The date and time the user assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeLastAssessed: description: The date and time the user assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The date and time the user assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string triggeredBy: description: Indicates whether the user assessment was created by the system or the user. enum: - USER - SYSTEM type: string type: description: "The type of the user assessment. The possible types are:\n\nLATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment.\nSAVED: A saved user assessment. All user assessments are saved in the user assessment history.\nSAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database.\nCOMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment.\n It also keeps track of user count and target count for each profile available on the targets in a given compartment. \n It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.\n" enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT type: string required: - compartmentId - displayName - id - lifecycleState - timeCreated - timeUpdated - type type: object GenerateDiscoveryReportForDownloadDetails: description: Details to generate a downloadable discovery report. properties: discoveryJobId: description: The OCID of the discovery job. maxLength: 255 minLength: 1 type: string reportFormat: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string required: - reportFormat type: object MaskingSchemaCollection: description: A collection of masking schema summary objects. properties: items: description: An array of masking schema summary objects. items: $ref: '#/components/schemas/MaskingSchemaSummary' type: array required: - items type: object SqlFirewallConfig: description: 'The SQL Firewall related configurations. ' properties: excludeJob: description: Specifies whether the firewall should include or exclude the database internal job activities. enum: - EXCLUDED - INCLUDED type: string status: description: Specifies if the firewall is enabled or disabled on the target database. enum: - ENABLED - DISABLED type: string timeStatusUpdated: description: The most recent time when the firewall status is updated, in the format defined by RFC3339. format: date-time type: string violationLogAutoPurge: description: "Specifies whether Data Safe should automatically purge the violation logs \nfrom the database after collecting the violation logs and persisting on Data Safe.\n" enum: - ENABLED - DISABLED type: string required: - status - violationLogAutoPurge type: object ReportDefinitionCollection: description: Collection of report definition objects. properties: items: description: Array of report definition summary. items: $ref: '#/components/schemas/ReportDefinitionSummary' type: array required: - items type: object EnableConditions: description: The details of the audit policy provisioning conditions. properties: entityNames: description: List of users or roles that the policy must be enabled for. items: maxLength: 512 minLength: 1 type: string type: array x-default-description: 'null' entitySelection: description: The entity include or exclude selection. enum: - INCLUDE - EXCLUDE type: string entityType: description: The entity type that the policy must be enabled for. enum: - USER - ROLE - ALL_USERS type: string operationStatus: description: The operation status that the policy must be enabled for. enum: - SUCCESS - FAILURE - BOTH type: string required: - entitySelection - entityType - operationStatus type: object MaskingReport: description: 'A masking report contains information about a completed masking request. It includes details such as the target database masked, masking policy used, masking start and finish time, total number of schemas, tables, columns and values masked, masked columns, and the masking formats used. ' properties: compartmentId: description: The OCID of the compartment that contains the masking report. maxLength: 100 minLength: 1 type: string id: description: The OCID of the masking report. maxLength: 255 minLength: 1 type: string isDropTempTablesEnabled: description: 'Indicates if the temporary tables created during the masking operation were dropped after masking. ' type: boolean isRedoLoggingEnabled: description: 'Indicates if redo logging was enabled during the masking operation. ' type: boolean isRefreshStatsEnabled: description: 'Indicates if statistics gathering was enabled during the masking operation. ' type: boolean lifecycleState: description: The current state of the masking report. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' maskingPolicyId: description: The OCID of the masking policy used. maxLength: 255 minLength: 1 type: string maskingStatus: description: The status of the masking job. enum: - FAILED - SUCCESS type: string maskingWorkRequestId: description: The OCID of the masking work request that resulted in this masking report. maxLength: 255 minLength: 1 type: string parallelDegree: description: 'Indicates if parallel execution was enabled during the masking operation. ' type: string recompile: description: 'Indicates how invalid objects were recompiled post the masking operation. ' type: string targetId: description: The OCID of the target database masked. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the masking report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeMaskingFinished: description: The date and time data masking finished, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string timeMaskingStarted: description: The date and time data masking started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) format: date-time type: string totalMaskedColumns: description: The total number of masked columns. format: int64 type: integer totalMaskedObjects: description: The total number of unique objects (tables and editioning views) that contain the masked columns. format: int64 type: integer totalMaskedSchemas: description: The total number of unique schemas that contain the masked columns. format: int64 type: integer totalMaskedSensitiveTypes: description: The total number of unique sensitive types associated with the masked columns. format: int64 type: integer totalMaskedValues: description: The total number of masked values. format: int64 type: integer totalPostMaskingScriptErrors: description: The total number of errors in post-masking script. format: int64 type: integer totalPreMaskingScriptErrors: description: The total number of errors in pre-masking script. format: int64 type: integer required: - id - compartmentId - lifecycleState - maskingWorkRequestId - maskingPolicyId - targetId - totalMaskedSensitiveTypes - totalMaskedSchemas - totalMaskedObjects - totalMaskedColumns - totalMaskedValues - timeMaskingStarted - timeMaskingFinished - maskingStatus type: object parameters: AlertFieldQueryParam: description: Specifies a subset of fields to be returned in the response. in: query name: field required: false x-default-description: Specifies a subset of fields to be returned in the response. style: form explode: true schema: type: array items: enum: - id - displayName - alertType - targetIds - targetNames - severity - status - operationTime - operation - operationStatus - timeCreated - timeUpdated - policyId - lifecycleState type: string AuditPolicyLifecycleStateQueryParam: description: The current state of the audit policy. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/AuditPolicyLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED NameQueryParam: description: The name of the report definition to query. in: query name: displayName x-default-description: null schema: type: string maxLength: 255 minLength: 1 TimeUpdatedLessThanQueryParam: description: 'Search for resources that were updated before a specific date. Specifying this parameter corresponding `timeUpdatedLessThan` parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. ' in: query name: timeUpdatedLessThan required: false schema: type: string format: date-time IsTargetGroupQueryParam: description: A filter to return only the target group related information if the OCID belongs to a target group. in: query name: isGroup required: false x-default-description: 'null' schema: type: boolean RoleNameContainsQueryParam: description: A filter to return only items if role name contains a specific string. in: query name: roleNameContains required: false x-default-description: 'null' schema: type: string SchemaNameContainsQueryParam: description: A filter to return only items if schema name contains a specific string. in: query name: schemaNameContains required: false x-default-description: 'null' schema: type: string TargetAlertPolicyAssociationIdPathParam: description: The OCID of the target-alert policy association. in: path name: targetAlertPolicyAssociationId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string UserCountLessThanQueryParam: description: 'An optional filter to return the profiles having user count less than the provided value. ' in: query name: userCountLessThan required: false x-default-description: An optional filter to return the profiles having user count less than the provided value. schema: type: string SqlFirewallPolicyGroupByQueryParam: description: The group by parameter to summarize SQL Firewall policy aggregation. in: query name: groupBy x-default-description: 'The group by parameter to summarize SQL Firewall policy aggregation. If not specified, the response will be grouped by securityPolicyId which is the default. ' style: form explode: true schema: type: array items: enum: - violationAction - enforcementScope - securityPolicyId - lifecycleState type: string SecurityAssessmentContainsSeverityQueryParam: description: A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels. in: query name: containsSeverity x-default-description: Fetch all findings regardless of their severity. style: form explode: true schema: type: array items: enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED maxLength: 255 minLength: 1 type: string SensitiveTypeIdsQueryParam: description: A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs. in: query name: sensitiveTypeId required: false x-default-description: Fetch all sensitive columns regardless of their sensitive type id. style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string SqlFirewallPolicyIdPathParam: description: The OCID of the SQL Firewall policy resource. in: path name: sqlFirewallPolicyId required: true schema: type: string maxLength: 255 minLength: 1 DifferenceAccessLevelQueryParam: description: 'Valid value is ACCESSIBLE. Default is ACCESSIBLE. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). ' in: query name: differenceAccessLevel schema: type: string enum: - ACCESSIBLE default: ACCESSIBLE GrantSortByQueryParam: description: 'The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending. ' in: query name: sortBy schema: type: string enum: - grantName - grantType - privilegeCategory - depthLevel - key default: key dataTypeQueryParam: description: A filter to return only resources that match the specified data types. in: query name: dataType required: false x-default-description: Fetch all masking formats. style: form explode: true schema: type: array items: enum: - CHARACTER - DATE - LOB - NUMERIC type: string IsSeededPoliciesQueryParam: description: A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies. in: query name: isSeeded required: false schema: type: boolean default: false reportDefinitionIdQueryParam: description: The ID of the report definition to filter the list of reports in: query name: reportDefinitionId x-default-description: null schema: type: string DepthLevelLessThanQueryParam: description: A filter to return only items that are at a level less than the specified user grant depth level. in: query name: depthLevelLessThan x-default-description: An optional filter to return only items that are at a level less than the specified user grant depth level. schema: type: integer format: int32 SchemaListQueryParam: description: A filter to return items that contain the specified schema list. in: query name: schemaList x-default-description: - null style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string SecurityPolicyIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the security policy resource. in: query name: securityPolicyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NA AlertIdPathParam: description: The OCID of alert. in: path name: alertId required: true schema: type: string maxLength: 255 minLength: 1 SecurityAssessmentReferencesQueryParam: description: An optional filter to return only findings that match the specified reference. in: query name: references x-default-description: An optional filter to return only findings that match the specified reference. x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentReferences' schema: type: string enum: - STIG - CIS - GDPR DiscoveryTypeQueryParam: description: A filter to return only the resources that match the specified discovery type. in: query name: discoveryType required: false x-default-description: Fetch all discovery jobs regardless of their discovery type. x-obmcs-enumref: '#/definitions/DiscoveryJob/discoveryType' schema: type: string RegistrationPolicyIdQueryParam: description: Filter to return the registration policy matching the specified OCID. in: query name: registrationPolicyId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MaskingReportIdPathParam: description: The OCID of the masking report. in: path name: maskingReportId required: true schema: type: string maxLength: 255 minLength: 1 MaskingColumnSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for other fields is ascending. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - schemaName - objectName - columnName - dataType default: timeCreated OptionalCompartmentIdQueryParam: description: A filter to return only resources that match the specified compartment OCID. in: query name: compartmentId required: false schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyNameQueryParam: description: The name of the unified audit policy. in: query name: unifiedAuditPolicyName x-default-description: 'null' schema: type: string AccessAnalyticsSortByQueryParam: description: 'The field to sort by. Only one sort parameter may be provided. ' in: query name: sortBy required: false schema: type: string enum: - USERNAME - COUNT default: COUNT MaskingAnalyticsSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - timeLastMasked TargetsWithPasswordAuthenticationQueryParam: description: A filter to return only the targets with the DB security feature - Password Authentication enabled/disabled. in: query name: targetsWithPasswordAuthentication x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE IsUserDefinedAlertPolicyQueryParam: description: An optional filter to return only alert policies that are user-defined or not. in: query name: isUserDefined required: false x-default-description: An optional filter to return only alert policies that are user-defined or not. schema: type: boolean default: false ParentCategoryIdQueryParam: description: A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID. in: query name: parentCategoryId required: false x-default-description: Fetch all sensitive types regardless of their parent category id. schema: type: string maxLength: 255 minLength: 1 FindingLifecycleStateQueryParam: description: A filter to return only the findings that match the specified lifecycle states. in: query name: lifecycleState required: false x-default-description: Fetch all findings regardless of their lifeCycleState. x-obmcs-top-level-enum: '#/definitions/FindingLifecycleState' schema: type: string enum: - ACTIVE - UPDATING - NEEDS_ATTENTION - FAILED AlertPolicyAssociationTargetTypeQueryParam: description: A optional filter to return only resources that belong to the specified alert policy association type. in: query name: targetType x-default-description: 'null' x-obmcs-enumref: '#/definitions/TargetAlertPolicyAssociation/targetType' schema: type: string TimeUserCreatedLessThanQueryParam: description: 'A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeUserCreatedLessThan required: false x-default-description: An optional filter to return users whose creation time in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time reportIdPathParam: description: Unique report identifier in: path name: reportId required: true schema: type: string maxLength: 255 minLength: 1 AuditPolicyIdQueryParam: description: An optional filter to return only resources that match the specified id. in: query name: auditPolicyId schema: type: string SdmMaskingPolicyDifferenceLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle states. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SdmMaskingPolicyDifference/lifecycleState' schema: type: string ArchiveRetrievalPaginationTokenQueryParam: description: For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: page x-default-description: For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). schema: type: string maxLength: 1024 minLength: 1 ReportDefinitionCategoryQueryParam: description: An optional filter to return only resources that match the specified category. in: query name: category required: false x-default-description: 'null' schema: type: string enum: - CUSTOM_REPORTS - SUMMARY - ACTIVITY_AUDITING SensitiveDataModelIdPathParam: description: The OCID of the sensitive data model. in: path name: sensitiveDataModelId required: true schema: type: string maxLength: 255 minLength: 1 TimePasswordExpiryGreaterThanOrEqualToQueryParam: description: 'A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timePasswordExpiryGreaterThanOrEqualTo required: false x-default-description: An optional filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time AssociatedResourceIdQueryParam: description: A filter to return the target databases that are associated to the resource id passed in as a parameter value. in: query name: associatedResourceId required: false schema: type: string maxLength: 255 minLength: 1 IsTopFindingQueryParam: description: A filter to return only the findings that are marked as top findings. in: query name: isTopFinding required: false x-default-description: 'null' schema: type: boolean MaskingPolicyIdPathParam: description: The OCID of the masking policy. in: path name: maskingPolicyId required: true schema: type: string maxLength: 255 minLength: 1 IsCompliantQueryParam: description: A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment. in: query name: isCompliant required: false x-default-description: 'null' schema: type: boolean TargetsWithFineGrainedAuditQueryParam: description: A filter to return only the targets with the DB security feature - Fine Grained Audit enabled/disabled. in: query name: targetsWithFineGrainedAudit x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE SortByQueryParam1: description: 'The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. ' in: query name: sortBy schema: type: string enum: - timeGenerated - displayName default: timeGenerated TimeUpdatedGreaterThanOrEqualToQueryParam: description: 'Search for resources that were updated after a specific date. Specifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo` parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. ' in: query name: timeUpdatedGreaterThanOrEqualTo required: false schema: type: string format: date-time SensitiveTypeIdQueryParam: description: A filter to return only items related to a specific sensitive type OCID. in: query name: sensitiveTypeId required: false x-default-description: Fetch all sensitive types regardless of their sensitive type id. schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyLifecycleStateQueryParam: description: The current state of the Unified Audit policy. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION - DELETED TargetsWithDatabaseVaultQueryParam: description: A filter to return only the targets with the DB security feature - Database Vault enabled/disabled. in: query name: targetsWithDatabaseVault x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE RegistrationPolicyConnectionIdQueryParam: description: Filter to return the registration policies matching the specified connection ID. in: query name: connectionId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 UserAssessmentLifecycleStateQueryParam: description: The current state of the user assessment. in: query name: lifecycleState x-default-description: The current state of the user assessment. x-obmcs-top-level-enum: '#/definitions/UserAssessmentLifecycleState' schema: type: string enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED SqlCollectionSortByQueryParam: description: 'The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy schema: type: string enum: - TIMECREATED - DISPLAYNAME - TIMELASTSTARTED default: TIMECREATED TriggeredByQueryParam: description: A filter to return user assessments that were created by either the system or by a user only. in: query name: triggeredBy x-default-description: An optional filter to return only user assessments that were created by either user or system. schema: type: string enum: - USER - SYSTEM IsScheduleUserAssessmentQueryParam: description: 'A filter to return only user assessments of type SAVE_SCHEDULE. ' in: query name: isScheduleAssessment required: false schema: type: boolean default: false ReferentialRelationKeyPathParam: description: 'The unique key that identifies the referential relation. It''s numeric and unique within a sensitive data model. ' in: path name: referentialRelationKey required: true schema: type: string maxLength: 255 minLength: 1 TargetsWithUnifiedAuditQueryParam: description: A filter to return only the targets with the DB security feature - Unified Audit enabled/disabled. in: query name: targetsWithUnifiedAudit x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE MaskingAnalyticsGroupBy: description: Attribute by which the masking analytics data should be grouped. in: query name: groupBy x-default-description: Fetch analytics data without a grouping input. schema: type: string enum: - targetId - policyId - targetIdAndPolicyId - sensitiveTypeId SecurityPolicyDeploymentIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the security policy deployment resource. in: query name: securityPolicyDeploymentId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MaskingErrorSortByQueryParam: description: The field to sort by. The default order will be ascending. in: query name: sortBy required: false schema: type: string enum: - stepName - timeCreated default: stepName RoleNameQueryParam: description: A filter to return only a specific role based on role name. in: query name: roleName required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string OnPremConnectorIdPathParam: description: The OCID of the on-premises connector. in: path name: onPremConnectorId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field used for sorting. Only one sorting parameter can be specified. The default order is descending. ' in: query name: sortBy required: false schema: type: string enum: - STARTTIME - FINISHTIME - ACCEPTEDTIME default: STARTTIME isRiskDeferredQueryParam: description: A filter to check findings whose risks were deferred by the user. in: query name: isRiskDeferred required: false x-default-description: 'null' schema: type: boolean UnifiedAuditPolicyDefinitionLifecycleStateQueryParam: description: The current state of the unified audit policy definition. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/UnifiedAuditPolicyDefinitionLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - NEEDS_ATTENTION ReferentialRelationsSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for key is descending. ' in: query name: sortBy schema: type: string enum: - key - relationType - schemaName - tableName default: key TemplateAssessmentIdQueryParam: description: The OCID of the security assessment of type TEMPLATE. in: query name: templateAssessmentId schema: type: string maxLength: 255 minLength: 1 CompartmentIdInSubtreeQueryParam: description: 'Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ''accessLevel'' setting. ' in: query name: compartmentIdInSubtree required: false schema: type: boolean default: false TargetsWithTablespaceEncryptionQueryParam: description: A filter to return only the targets with the DB security feature - Tablespace Encryption enabled/disabled. in: query name: targetsWithTablespaceEncryption x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE OptionalRootCompartmentIdQueryParam: description: A filter to return the Data Safe configuration for the specified tenancy OCID. in: query name: compartmentId required: false schema: type: string maxLength: 255 minLength: 1 AuditProfileIdPathParam: description: The OCID of the audit. in: path name: auditProfileId required: true schema: type: string maxLength: 255 minLength: 1 InUseAttributeSetQueryParam: description: A filter to return attribute set resources that are in use by other associated resources. in: query name: inUse required: false x-default-description: 'null' schema: type: string enum: - 'YES' - 'NO' ClusterIdHeader: description: 'Identifier of the cluster of the CDB associated to the registration policy being created. ' in: header name: x-cluster-id required: false x-default-description: 'null' schema: type: string UserNameQueryParam: description: A filter to return only items that match the specified user name. in: query name: userName x-default-description: An optional filter to return only items that match the specified user name. schema: type: string LibraryMaskingFormatSourceQueryParam: description: A filter to return the library masking format resources based on the value of their source attribute. in: query name: libraryMaskingFormatSource required: false x-obmcs-top-level-enum: '#/definitions/LibraryMaskingFormatSource' schema: type: string enum: - ORACLE - USER default: USER UserProfileQueryParam: description: A filter to return only items that match the specified user profile. in: query name: userProfile x-default-description: An optional filter to return only items that match the specified user profile. schema: type: string maxLength: 50 minLength: 1 TargetDatabaseLifecycleStateQueryParam: description: A filter to return only target databases that match the specified lifecycle state. in: query name: lifecycleState x-default-description: A filter to return only target databases that match the specified lifecycle state. x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - NEEDS_ATTENTION - FAILED SqlCollectionGroupByQueryParam: description: The group by parameter to summarize SQL collection aggregation. in: query name: groupBy x-default-description: 'The group by parameter to summarize SQL collection aggregation. If not specified, the response will be grouped by targetId which is the default. ' style: form explode: true schema: type: array items: enum: - targetId - lifecycleState type: string PaginationLimitQueryParam: description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit x-default-description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). schema: type: integer maximum: 1000 minimum: 1 TimeStartQueryParam: description: 'An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeStarted required: false x-default-description: 'An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' schema: type: string format: date-time ResourceIdQueryParam: description: A filter to return only work requests that match the specified resource OCID. in: query name: resourceId required: false schema: type: string maxLength: 255 minLength: 1 SecurityPolicyReportLifecycleStateQueryParam: description: The current state of the security policy report. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityPolicyReportLifecycleState' schema: type: string enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED - NEEDS_ATTENTION maxLength: 255 minLength: 1 DifferenceColumnKeyPathParam: description: The unique key that identifies the difference column. in: path name: differenceColumnKey required: true schema: type: string maxLength: 255 minLength: 1 SensitiveTypeGroupLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: Fetch all sensitive type groups resources regardless of their lifecycle state. x-obmcs-top-level-enum: '#/definitions/SensitiveTypeGroupLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED SecurityPolicyEntryTargetIdQueryParam: description: An optional filter to return only resources that match the specified target id. in: query name: targetId schema: type: string maxLength: 255 minLength: 1 AuditProfileGroupByQueryParam: description: The group by parameter for summarize operation on audit. in: query name: groupBy x-default-description: 'null' style: form explode: true schema: type: array items: enum: - isPaidUsageEnabled - targetType - paidUsageSource - onlineMonthsSource - offlineMonthsSource type: string AlertGroupByQueryParam: description: 'A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. ' in: query name: groupBy required: false x-default-description: Name of the field by which alerts summary should be grouped by. style: form explode: true schema: type: array items: enum: - alertType - targetIds - targetNames - alertSeverity - alertStatus - timeCreated - policyId type: string SqlFirewallPolicyTimeEndQueryParam: description: 'An optional filter to return the summary of the SQL Firewall policies created before the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeEnded required: false x-default-description: 'null' schema: type: string format: date-time TimeValidUntilLessThanQueryParam: description: "Specifying `TimeValidUntilLessThanQueryParam` parameter\nwill retrieve all items for which the risk level modification by user will \nbe valid until less than the date and time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n\n**Example:** 2016-12-19T00:00:00.000Z\n" in: query name: timeValidUntilLessThan required: false x-default-description: "An optional filter to return items where the risk level modification by user will \nbe valid until less than the date and time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" schema: type: string format: date-time SecurityAssessmentTargetTypeQueryParam: description: A filter to return only only target database resources or target database group resources. in: query name: targetType x-default-description: An optional filter to return only target database resources or target database group resources. x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentTargetType' schema: type: string enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP SchemaListSortByQueryParam: description: 'The field used for sorting. Only one sorting order (sortOrder) can be specified. ' in: query name: sortBy schema: type: string enum: - SCHEMANAME default: SCHEMANAME TableAccessEntrySortByQueryParam: description: 'The field to sort by. Only one sort parameter should be provided. ' in: query name: sortBy required: false x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' schema: type: string enum: - key - grantee - accessType - tableSchema - tableName - privilegeType - privilege - privilegeGrantable - grantFromRole - accessThroughObject - columnName - grantor - areAllTablesAccessible - isAccessConstrainedByView - isAccessConstrainedByLabelSecurity - isAccessConstrainedByDatabaseVault - isAccessConstrainedByVirtualPrivateDatabase - isAccessConstrainedByRedaction - isAccessConstrainedByRealApplicationSecurity - isAccessConstrainedBySqlFirewall - isSensitive default: key GrantKeyQueryParam: description: A filter to return only items that match the specified user grant key. in: query name: grantKey x-default-description: An optional filter to return only items that match the specified user grant key. schema: type: string UserSortByQueryParam: description: 'The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. ' in: query name: sortBy schema: type: string enum: - userName - userCategory - accountStatus - timeLastLogin - targetId - timeUserCreated - authenticationType - timePasswordChanged default: userName PlannedActionForDifferenceColumnQueryParam: description: A filter to return only the SDM masking policy difference columns that match the specified planned action. in: query name: plannedAction required: false x-default-description: Fetch all SDM masking policy difference columns regardless of their planned action. x-obmcs-enumref: '#/definitions/DifferenceColumn/plannedAction' schema: type: string SensitiveTypeIdPathParam: description: The OCID of the sensitive type. in: path name: sensitiveTypeId required: true schema: type: string maxLength: 255 minLength: 1 ScheduleSecurityAssessmentIdQueryParam: description: The OCID of the security assessment of type SAVE_SCHEDULE. in: query name: scheduleAssessmentId x-default-description: The OCID of the security assessment of type SAVE_SCHEDULE. schema: type: string maxLength: 255 minLength: 1 SdmMaskingPolicyDifferenceSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreationStarted is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreationStarted - displayName default: timeCreationStarted AttributeSetIdPathParam: description: OCID of an attribute set. in: path name: attributeSetId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: The sort order to use, either ascending (ASC) or descending (DESC). in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC TargetsWithPrivilegeAnalysisQueryParam: description: A filter to return only the targets with the DB security feature - Privilege Analysis enabled/disabled. in: query name: targetsWithPrivilegeAnalysis x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE AuditTrailLifecycleStateQueryParam: description: A optional filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/AuditTrailLifecycleState' schema: type: string enum: - INACTIVE - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION UserAssessmentSortByQueryParam: description: 'The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated TargetDatabaseGroupIdQueryParam: description: A filter to return the target database group that matches the specified OCID. in: query name: targetDatabaseGroupId required: false schema: type: string maxLength: 255 minLength: 1 TimeLastLoginGreaterThanOrEqualToQueryParam: description: 'A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeLastLoginGreaterThanOrEqualTo required: false x-default-description: An optional filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time UserCategoryQueryParam: description: A filter to return only items that match the specified user category. in: query name: userCategory x-default-description: An optional filter to return only items that match the specified user category. schema: type: string maxLength: 50 minLength: 1 SensitiveColumnLifecycleStateQueryParam: description: Filters the sensitive column resources with the given lifecycle state values. in: query name: sensitiveColumnLifecycleState required: false x-default-description: Fetch all sensitive columns regardless of their lifecycle state. x-obmcs-top-level-enum: '#/definitions/SensitiveColumnLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED TimeUserCreatedGreaterThanOrEqualToQueryParam: description: 'A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeUserCreatedGreaterThanOrEqualTo required: false x-default-description: An optional filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time PlannedActionQueryParam: description: A filter to return only the resources that match the specified planned action. in: query name: plannedAction required: false x-default-description: Fetch all discovery jobs regardless of their planned action. x-obmcs-enumref: '#/definitions/DiscoveryJobResult/plannedAction' schema: type: string UserTypeQueryParam: description: "A filter to return only items that match the specified user type. The possible values can be\n - ADMIN_PRIVILEGED\n - APPLICATION\n - PRIVILEGED\n - SCHEMA\n - NON_PRIVILEGED\nas specified by '#/definitions/userTypes'.\n" in: query name: userType x-default-description: An optional filter to return only items that match the specified user type. schema: type: string maxLength: 50 minLength: 1 AlertSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated SchemaTypeQueryParam: description: A filter to return only items related to specific type of schema. in: query name: isOracleMaintained required: false x-default-description: 'null' schema: type: boolean SqlFirewallViolationSCIMQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** query=(operationTime ge "2021-06-04T01:00:26.000Z") and (violationAction eq "BLOCKED") ' in: query name: scimQuery required: false x-default-description: 'An optional query parameter to filter SQL violation records based on a SCIM query. ' schema: type: string maxLength: 2048 minLength: 1 TimeCreatedGreaterOrEqualToQueryParam: description: 'A filter to return only user assessments that were created after the specified date and time, as defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date. **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeCreatedGreaterThanOrEqualTo required: false x-default-description: An optional filter to return assessments that were created after a specific date. schema: type: string format: date-time AuditPolicyIdPathParam: description: Unique audit policy identifier. in: path name: auditPolicyId required: true schema: type: string PasswordVerificationFunctionQueryParam: description: An optional filter to filter the profiles based on password verification function. in: query name: passwordVerificationFunction required: false x-default-description: An optional filter to list user profiles having specific password verification function. schema: type: string TargetDatabaseGroupIdPathParam: description: The OCID of the specified target database group. in: path name: targetDatabaseGroupId required: true schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyDefinitionIdPathParam: description: The OCID of the unified audit policy definition resource. in: path name: unifiedAuditPolicyDefinitionId required: true schema: type: string maxLength: 255 minLength: 1 ModifiedByQueryParam: description: A filter to check which user modified the risk level of the finding. in: query name: modifiedBy required: false x-default-description: 'null' schema: type: string IsMaskingEnabledQueryParam: description: 'A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy. ' in: query name: isMaskingEnabled required: false x-default-description: Fetch enabled and disabled masking columns. schema: type: boolean SuggestedSeverityQueryParam: description: A filter to return only checks of a particular risk level. in: query name: suggestedSeverity x-default-description: Fetch all checks regardless of their severity. schema: type: string enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED TargetsWithTraditionalAuditQueryParam: description: A filter to return only the targets with the DB security feature - Traditional Audit enabled/disabled. in: query name: targetsWithTraditionalAudit x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE FailedLoginAttemptsGreaterThanOrEqualQueryParam: description: 'An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: failedLoginAttemptsGreaterThanOrEqual required: false x-default-description: An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. schema: type: string ArchiveRetrievalIdPathParam: description: OCID of the archive retrieval. in: path name: auditArchiveRetrievalId required: true schema: type: string maxLength: 255 minLength: 1 TemplateBaselineAssessmentIdQueryParam: description: The OCID of the security assessment of type TEMPLATE_BASELINE. in: query name: templateBaselineAssessmentId schema: type: string maxLength: 255 minLength: 1 AuditProfileIdQueryParam: description: A optional filter to return only resources that match the specified id. in: query name: auditProfileId schema: type: string maxLength: 255 minLength: 1 MaskPolicyRelationTypeQueryParam: description: 'A filter to return columns based on their relationship with their parent columns. If set to NONE, it returns the columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. ' in: query name: relationType required: false x-default-description: Fetch all regardless of their relation types. style: form explode: true schema: type: array items: enum: - NONE - APP_DEFINED - DB_DEFINED type: string WorkRequestIdPathParam: description: The OCID of the work request. in: path name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 PrivilegeCategoryQueryParam: description: A filter to return only items that match the specified user privilege category. in: query name: privilegeCategory x-default-description: An optional filter to return only items that match the specified user privilege category. schema: type: string maxLength: 50 minLength: 1 DataSourceQueryParam: description: Specifies the name of a resource that provides data for the report. For example alerts, events. in: query name: dataSource required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ReportDefinitionDataSource' schema: type: string enum: - EVENTS - ALERTS - VIOLATIONS - ALLOWED_SQL ReportDefinitionLifecycleStateQueryParam: description: An optional filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/ReportDefinitionLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED FindingAnalyticsGroupBy: description: Attribute by which the finding analytics data should be grouped. in: query name: groupBy x-default-description: 'null' schema: type: string enum: - findingKeyAndTopFindingStatus - findingKeyAndSeverity - severity MaskPolicyReferentialRelationsPaginationLimitQueryParam: description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit x-default-description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). schema: type: integer maximum: 500 minimum: 1 ProfileNameQueryParam: description: A filter to return only items that match the specified profile name. in: query name: profileName x-default-description: An optional filter to return only items that match the specified profile name. schema: type: string FilterQueryParam: description: 'The scim query filter parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Ex:** filter=(targetDatabaseId eq ''ocid1.datasafetargetdatabase.oc1.iad.abuwcljr3u2va4ba5wek53idpe5qq5kkbigzclscc6mysfecxzjt5dgmxqza'') ' in: query name: filter required: false x-default-description: 'null' schema: type: string maxLength: 4000 minLength: 1 TimeGeneratedLessThanQueryParam: description: 'Search for resources that were generated before a specific date. Specifying this parameter corresponding `timeGeneratedLessThan` parameter will retrieve all resources generated before the specified generated date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeGeneratedLessThan required: false x-default-description: An optional filter to return resources that were generated before a specific date. schema: type: string format: date-time MaskingPolicyHealthReportLogsSortByQueryParam: description: sort by in: query name: sortBy required: false schema: type: string enum: - logType default: logType AuditPolicyCategoryQueryParam: description: The category to which the audit policy belongs to. in: query name: auditPolicyCategory x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AuditPolicyCategory' schema: type: string enum: - BASIC_ACTIVITY - ADMIN_USER_ACTIVITY - USER_ACTIVITY - ORACLE_PREDEFINED - COMPLIANCE_STANDARD - CUSTOM - SQL_FIREWALL_AUDITING UnassociatedTargetMemberSortByQueryParam: description: 'The field to sort by. Only one sort parameter may be provided. ' in: query name: sortBy required: false schema: type: string enum: - targetId - notAppliedReason default: targetId InactiveAccountTimeLessThanQueryParam: description: 'An optional filter to return the profiles allowing inactive account time in days less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: inactiveAccountTimeLessThan required: false x-default-description: An optional schema: type: string ScheduleUserAssessmentIdQueryParam: description: The OCID of the user assessment of type SAVE_SCHEDULE. in: query name: scheduleUserAssessmentId x-default-description: The OCID of the user assessment of type SAVE_SCHEDULE. schema: type: string maxLength: 255 minLength: 1 RegistrationPoliciesSortByQueryParam: description: 'Field to sort the registration policies by. Only one sort order (sortOrder) can be specified. Defaults to sorting by `timeCreated` in descending order ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - enablementLevel - lifecycleState default: timeCreated DataTypeQueryParam: description: A filter to return only the resources that match the specified data types. in: query name: dataType required: false x-default-description: Fetch all sensitive columns regardless of their data type. style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string SecurityPolicyReportIdPathParam: description: The OCID of the security policy report resource. in: path name: securityPolicyReportId required: true schema: type: string maxLength: 255 minLength: 1 SensitiveDataModelSensitiveTypesSortByQueryParam: description: '- The field to sort by. You can specify only one sorting parameter (sortorder). The default order is descending. ' in: query name: sortBy schema: type: string enum: - count default: count SecurityAssessmentTypeQueryParam: description: A filter to return only items that match the specified security assessment type. in: query name: type required: false x-default-description: An optional filter to return only items that match the specified security assessment type. schema: type: string enum: - LATEST - SAVED - SAVE_SCHEDULE - COMPARTMENT - TEMPLATE - TEMPLATE_BASELINE DatabaseSecurityConfigIdPathParam: description: The OCID of the database security configuration resource. in: path name: databaseSecurityConfigId required: true schema: type: string maxLength: 255 minLength: 1 DatabaseSecurityConfigLifecycleStateQueryParam: description: The current state of the database security configuration. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DatabaseSecurityConfigLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED RegistrationPoliciesLifecycleStateQueryParam: description: Filter registration policies by their lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/RegistrationPolicy/lifecycleState' schema: type: string AlertPolicyIdQueryParam: description: A filter to return policy by it's OCID. in: query name: alertPolicyId required: false x-default-description: An optional filter to return policy by it's OCID. schema: type: string maxLength: 255 minLength: 1 SecurityPolicyDeploymentIdPathParam: description: The OCID of the security policy deployment resource. in: path name: securityPolicyDeploymentId required: true schema: type: string maxLength: 255 minLength: 1 IsScheduleSecurityAssessmentQueryParam: description: 'A filter to return only security assessments of type save schedule. ' in: query name: isScheduleAssessment required: false schema: type: boolean default: false AuditTrailStatusQueryParam: description: A optional filter to return only resources that match the specified sub-state of audit trail. in: query name: status x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AuditTrailStatus' schema: type: string enum: - STARTING - COLLECTING - RECOVERING - IDLE - STOPPING - STOPPED - RESUMING - RETRYING - NOT_STARTED - STOPPED_NEEDS_ATTN - STOPPED_FAILED SqlFirewallViolationSortByQueryParam: description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' in: query name: sortBy required: false x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' schema: type: string enum: - dbUserName - targetId - targetName - operationTime - timeCollected - clientOsUserName - operation - currentDbUserName - sqlLevel - clientIp - clientProgram - violationCause - violationAction default: operationTime WorkRequestIdQueryParam: description: The OCID of the work request. in: query name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 DatabaseViewAccessEntryKeyPathParam: description: The unique key that identifies the view access object. This is a system-generated identifier. in: path name: databaseViewAccessEntryKey required: true schema: type: string maxLength: 255 minLength: 1 UserProfileSortByQueryParam: description: 'The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC. ' in: query name: sortBy schema: type: string enum: - profileName - targetId - isUserCreated - passwordVerificationFunction - userCount - sessionsPerUser - inactiveAccountTime - passwordLockTime - failedLoginAttempts default: targetId ColumnNameContainsQueryParam: description: A filter to return only items if column name contains a specific string. in: query name: columnNameContains required: false x-default-description: 'null' schema: type: string IsPaidUsageEnabledQueryParam: description: 'Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level. ' in: query name: isPaidUsageEnabled x-default-description: 'null' schema: type: boolean AuditPolicyNameQueryParam: description: 'In case of seeded policies, it is the policy name defined by Data Safe. In case of custom Policies, it is the policy name that is used to create the policies on the target database. In case of Oracle Pre-seeded policies, it is the default policy name of the same. ' in: query name: auditPolicyName x-default-description: 'null' schema: type: string ProfileNamePathParam: description: Profile name to get detailed information . in: path name: profileName required: true schema: type: string maxLength: 128 minLength: 1 TableListSortByQueryParam: description: 'The field used for sorting. Only one sorting order (sortOrder) can be specified. ' in: query name: sortBy schema: type: string enum: - SCHEMANAME - TABLENAME default: TABLENAME AvailableAuditVolumeSortByQueryParam: description: 'The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. ' in: query name: sortBy schema: type: string enum: - monthInConsideration - volume - trailLocation default: monthInConsideration CompartmentIdHeader: description: A header param to create bulk resources in the specified compartment OCID. in: header name: opc-compartment-id required: true schema: type: string maxLength: 100 minLength: 1 PrivilegeTypeQueryParam: description: A filter to return only items that match the specified privilege grant type. in: query name: privilegeType x-default-description: An optional filter to return only items that match the specified privilege grant type. schema: type: string maxLength: 50 minLength: 1 AuditProfileLifecycleStateQueryParam: description: A optional filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/AuditProfileLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - FAILED - NEEDS_ATTENTION - DELETED TargetIdQueryParam: description: A filter to return only items related to a specific target OCID. in: query name: targetId x-default-description: An optional filter to return only items related to a specific target OCID. schema: type: string maxLength: 255 minLength: 1 ReportLifecycleStateQueryParam: description: An optional filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState x-obmcs-top-level-enum: '#/definitions/ReportLifecycleState' schema: type: string enum: - UPDATING - ACTIVE - CREATING - FAILED CollectedAuditVolumeSortByQueryParam: description: 'The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending. ' in: query name: sortBy schema: type: string enum: - monthInConsideration - onlineVolume - archivedVolume default: monthInConsideration TimeValidUntilGreaterThanOrEqualToQueryParam: description: "Specifying `TimeValidUntilGreaterThanOrEqualToQueryParam` parameter \nwill retrieve all items for which the risk level modification by user will \nno longer be valid greater than the date and time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n\n**Example:** 2016-12-19T00:00:00.000Z\n" in: query name: timeValidUntilGreaterThanOrEqualTo required: false schema: type: string format: date-time SensitiveTypeSourceQueryParam: description: A filter to return the sensitive type resources based on the value of their source attribute. in: query name: sensitiveTypeSource required: false x-obmcs-top-level-enum: '#/definitions/SensitiveTypeSource' schema: type: string enum: - ORACLE - USER default: USER AlertPolicySortByQueryParam: description: 'The field to sort by. Only one sort parameter may be provided. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated SqlCollectionIdPathParam: description: The OCID of the SQL collection resource. in: path name: sqlCollectionId required: true schema: type: string maxLength: 255 minLength: 1 MaskingPolicyIdQueryParam: description: A filter to return only the resources that match the specified masking policy OCID. in: query name: maskingPolicyId required: false schema: type: string maxLength: 255 minLength: 1 SqlCollectionLogInsightsTimeStartQueryParam: description: 'An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeStarted required: true x-default-description: 'null' schema: type: string format: date-time WorkRequestOperationQueryParam: description: A filter to return only work requests that match the specific operation type. in: query name: operationType required: false schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: A filter to return only resources that match the specified compartment OCID. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 EventSCIMQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** (auditEventTime ge "2021-06-04T01:00:26.000Z") and (eventName eq "LOGON") The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. These define admin user activity, common user activity, sensitive data activity and data safe activity **Example:** (adminUser eq 1) ' in: query name: scimQuery required: false x-default-description: 'An optional query parameter to filter audit event records based on a SCIM query. ' schema: type: string maxLength: 2048 minLength: 1 IsSensitiveQueryParam: description: 'Returns referential relations containing sensitive columns when true. Returns referential relations containing non sensitive columns when false. ' in: query name: isSensitive required: false x-default-description: 'Returns all the referential relations in the sensitive data model. ' schema: type: boolean IsUserDefinedAttributeSetQueryParam: description: A filter to return user defined or seeded attribute set resources that matches the specified is user defined query param. A true value indicates user defined attribute set. in: query name: isUserDefined required: false schema: type: boolean default: true SensitiveTypesExportIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the sensitive types export resource. in: query name: sensitiveTypesExportId required: false x-default-description: Fetch all sensitive types export regardless of their sensitive types export id. schema: type: string maxLength: 255 minLength: 1 AttributeSetAssociatedResourceIdQueryParam: description: A filter to return attribute set associated resource that matches the specified associated resource id query param. in: query name: associatedResourceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AlertPolicyTypeQueryParam: description: An optional filter to return only alert policies of a certain type. in: query name: type required: false x-default-description: An optional filter to return only alert policies of a certain type. x-obmcs-top-level-enum: '#/definitions/AlertPolicyType' schema: type: string enum: - AUDITING - SECURITY_ASSESSMENT - USER_ASSESSMENT FindingKeyPathParam: description: The unique key that identifies the finding. It is a string and unique within a security assessment. in: path name: findingKey required: true schema: type: string maxLength: 255 minLength: 1 SeverityQueryParam: description: A filter to return only findings of a particular risk level. in: query name: severity x-default-description: Fetch all findings regardless of their severity. schema: type: string enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED IsOverrideGlobalRetentionSettingQueryParam: description: A optional filter to return only resources that match the specified retention configured value. in: query name: isOverrideGlobalRetentionSetting x-default-description: 'null' schema: type: boolean TargetsWithNetworkEncryptionQueryParam: description: A filter to return only the targets with the DB security feature - Network Encryption enabled/disabled. in: query name: targetsWithNetworkEncryption x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE SecurityPolicyReportSCIMQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** query=(accessType eq "SELECT") and (grantee eq "ADMIN") ' in: query name: scimQuery required: false x-default-description: 'An optional query parameter to filter SecurityPolicy Report records based on a SCIM query. ' schema: type: string maxLength: 2048 minLength: 1 RelationTypeQueryParam: description: 'A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. ' in: query name: relationType required: false x-default-description: Fetch all regardless of their relation types. style: form explode: true schema: type: array items: enum: - NONE - APP_DEFINED - DB_DEFINED type: string AuditTrailIdQueryParam: description: A optional filter to return only resources that match the specified id. in: query name: auditTrailId schema: type: string maxLength: 255 minLength: 1 RoleListSortByQueryParam: description: 'The field used for sorting. Only one sorting order (sortOrder) can be specified. ' in: query name: sortBy schema: type: string enum: - ROLENAME default: ROLENAME FindingKeyQueryParam: description: The unique key that identifies the finding. It is a string and unique within a security assessment. in: query name: findingKey required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ObjectTypeQueryParam: description: A filter to return only items related to a specific object type. in: query name: objectType required: false style: form explode: true schema: type: array items: enum: - ALL - TABLE - EDITIONING_VIEW type: string default: - ALL DatabaseTableAccessEntryKeyPathParam: description: The unique key that identifies the table access object. This is a system-generated identifier. in: path name: databaseTableAccessEntryKey required: true schema: type: string maxLength: 255 minLength: 1 OnPremConnectorLifecycleStateQueryParam: description: A filter to return only on-premises connector resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/OnPremConnectorLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION UserCountGreaterThanOrEqualQueryParam: description: 'An optional filter to return the profiles having user count greater than or equal to the provided value. ' in: query name: userCountGreaterThanOrEqual required: false x-default-description: An optional filter to return the profiles having user count greater than or equal to the provided value. schema: type: string DatabaseTypeQueryParam: description: A filter to return only target databases that match the specified database type. in: query name: databaseType x-default-description: A filter to return only target databases that match the specified database type. x-obmcs-top-level-enum: '#/definitions/DatabaseType' schema: type: string enum: - DATABASE_CLOUD_SERVICE - AUTONOMOUS_DATABASE - INSTALLED_DATABASE SensitiveColumnKeyPathParam: description: The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. in: path name: sensitiveColumnKey required: true schema: type: string maxLength: 255 minLength: 1 SecurityPolicyIdPathParam: description: The OCID of the security policy resource. in: path name: securityPolicyId required: true schema: type: string maxLength: 255 minLength: 1 SqlFirewallPolicyUserNameQueryParam: description: A filter to return only items that match the specified user name. in: query name: dbUserName x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 DiscoveryJobIdQueryParam: description: A filter to return only the resources that match the specified discovery job OCID. in: query name: discoveryJobId required: false x-default-description: Fetch all discovery jobs. schema: type: string maxLength: 255 minLength: 1 ColumnNameQueryParam: description: A filter to return only a specific column based on column name. in: query name: columnName required: false x-default-description: - null style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string AuthenticationTypeQueryParam: description: A filter to return only items that match the specified authentication type. in: query name: authenticationType x-default-description: An optional filter to return only items that match the specified authentication type. schema: type: string maxLength: 50 minLength: 1 IsComparedQueryParam: description: A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done. in: query name: isCompared required: false x-default-description: 'null' schema: type: boolean AccountStatusQueryParam: description: A filter to return only items that match the specified account status. in: query name: accountStatus x-default-description: An optional filter to return only items that match the specified account status. schema: type: string maxLength: 50 minLength: 1 ColumnGroupQueryParam: description: A filter to return only the sensitive columns that belong to the specified column group. in: query name: columnGroup required: false x-default-description: Fetch all sensitive columns regardless of their column group. schema: type: string ColumnListSortByQueryParam: description: 'The field used for sorting. Only one sorting order (sortOrder) can be specified. ' in: query name: sortBy schema: type: string enum: - SCHEMANAME - TABLENAME - COLUMNNAME - DATATYPE default: COLUMNNAME AuditEventSummarySortByQueryParam: description: If this query parameter is specified, the result is ordered based on this query parameter value. in: query name: sortBy required: false x-default-description: If this query parameter is specified, the result is ordered based on this query parameter value. schema: type: string enum: - targetId - targetClass - targetName - objectType - dbUserName - eventName - auditEventTime - clientHostname - clientProgram - clientId - auditType - objectOwner - auditPolicies - objectName - osUserName - errorCode - clientIp - externalUserId maxLength: 128 minLength: 1 AuditTrailIdPathParam: description: The OCID of the audit trail. in: path name: auditTrailId required: true schema: type: string maxLength: 255 minLength: 1 TargetAlertPolicyAssociationIdQueryParam: description: A filter to return only items related to a specific target-alert policy association ID. in: query name: targetAlertPolicyAssociationId required: false x-default-description: An optional filter to return only items related to a specific target-alert policy association ID. schema: type: string MaskPolicyReferentialRelationsSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). ' in: query name: sortBy schema: type: string enum: - relationType - schemaName - objectName default: schemaName TargetIdsQueryParam: description: An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids. in: query name: targetIds x-default-description: An optional filter to return only findings that match the specified target ids. style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string maxItems: 100 MaskingPolicyHealthReportIdQueryParam: description: A filter to return only the resources that match the specified masking policy health report OCID. in: query name: maskingPolicyHealthReportId required: false schema: type: string maxLength: 255 minLength: 1 SensitiveTypeSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated IsUserCreatedQueryParam: description: An optional filter to return the user created profiles. in: query name: isUserCreated required: false x-default-description: An optional filter to return the user created profiles. schema: type: boolean ResultKeyPathParam: description: The unique key that identifies the discovery result. in: path name: resultKey required: true schema: type: string maxLength: 255 minLength: 1 AuditProfileTargetTypeQueryParam: description: A optional filter to return only resources that belong to the specified audit profile type. in: query name: targetType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AuditProfileTargetType' schema: type: string enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP TargetDatabaseGroupsLifecycleStateQueryParam: description: A filter to retrieve resources that exclusively align with the designated lifecycle state. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/TargetDatabaseGroupLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION MaskingPolicyHealthReportIdPathParam: description: The OCID of the masking health report. in: path name: maskingPolicyHealthReportId required: true schema: type: string maxLength: 255 minLength: 1 TimeLastLoginLessThanQueryParam: description: 'A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeLastLoginLessThan required: false x-default-description: An optional filter to return users whose last login time in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time SyncStatusQueryParam: description: A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute. in: query name: syncStatus required: false x-default-description: Fetch all SDM masking policy difference columns regardless of their synced status. x-obmcs-enumref: '#/definitions/DifferenceColumn/syncStatus' schema: type: string SqlFirewallPolicyLifecycleStateQueryParam: description: The current state of the SQL Firewall policy. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SqlFirewallPolicyLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION SensitiveTypeGroupIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the sensitive type group resource. in: query name: sensitiveTypeGroupId required: false x-default-description: Fetch all sensitive type groups regardless of their sensitive type group id. schema: type: string maxLength: 255 minLength: 1 IsSeededPolicyDefinitionsQueryParam: description: A boolean flag indicating to list seeded unified audit policy definitions. Set this parameter to get list of seeded unified audit policy definitions. in: query name: isSeeded required: false schema: type: boolean default: false SqlFirewallAllowedSqlSortByQueryParam: description: 'The field to sort by. Only one sort parameter should be provided. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCollected default: timeCollected IsCommonSensitiveTypeQueryParam: description: "A filter to return only the common sensitive type resources. Common sensitive types belong to \nlibrary sensitive types which are frequently used to perform sensitive data discovery.\n" in: query name: isCommon required: false x-default-description: Fetch all sensitive types regardless of their isCommon attribute value. schema: type: boolean RegistrationPoliciesResourceIdQueryParam: description: Filter to return the registration policy matching the specified resource OCID. in: query name: resourceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SecurityAssessmentContainsReferencesQueryParam: description: An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references. in: query name: containsReferences x-default-description: An optional filter to return only findings that match the specified references. style: form explode: true schema: type: array items: enum: - STIG - CIS - GDPR maxLength: 255 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentReferences' SecurityPolicyEntryTypeQueryParam: description: The type of the security policy deployment. in: query name: securityPolicyEntryType x-default-description: 'null' x-obmcs-enumref: '#/definitions/SecurityPolicyEntryStateSummary/entryType' schema: type: string DiscoveryJobIdPathParam: description: The OCID of the discovery job. in: path name: discoveryJobId required: true schema: type: string maxLength: 255 minLength: 1 ArchiveRetrievalIdQueryParam: description: OCID of the archive retrieval. in: query name: auditArchiveRetrievalId required: false schema: type: string maxLength: 255 minLength: 1 ComparisonUserAssessmentIdPathParam: description: The OCID of the baseline user assessment. in: path name: comparisonUserAssessmentId required: true schema: type: string maxLength: 255 minLength: 1 SecurityPolicyDeploymentTargetTypeQueryParam: description: A optional filter to return only resources that belong to the specified target type. in: query name: targetType x-default-description: 'null' x-obmcs-enumref: '#/definitions/SecurityPolicyDeployment/targetType' schema: type: string DiscoveryAnalyticsSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - timeLastDiscovered FindingAnalyticsScimQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** | scimQuery=(severity eq ''high'') scimQuery=(category eq "Users") and (reference eq ''CIS'') Supported fields: severity reference title category ' in: query name: scimQuery required: false x-default-description: 'null' schema: type: string maxLength: 2048 minLength: 1 IsBaselineQueryParam: description: A filter to return only user assessments that are set as baseline. in: query name: isBaseline schema: type: boolean default: false SensitiveObjectSortByQueryParam: description: "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" in: query name: sortBy schema: type: string enum: - schemaName - objectName - objectType default: schemaName GranteeQueryParam: description: A filter to return only items that match the specified grantee. in: query name: grantee required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SqlFirewallPolicyIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the SQL Firewall policy resource. in: query name: sqlFirewallPolicyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SqlFirewallViolationSummaryFieldQueryParam: description: Specifies a subset of summarized fields to be returned in the response. in: query name: summaryField required: false x-default-description: Specifies a subset of summarized fields to be returned in the response. style: form explode: true schema: type: array items: enum: - dbUserName - targetName - clientOsUserName - operation - sqlText - currentDbUserName - sqlLevel - clientIp - clientProgram - violationCause - violationAction - selects - creates - alters - drops - grants - revokes type: string AuditEventPaginationTokenQueryParam: description: 'It is usually retrieved from a previous "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page required: false x-default-description: 'For list pagination. The page token representing the page at which to start retrieving results. ' schema: type: string maxLength: 1024 minLength: 1 TypeQueryParam: description: A filter to return only items that match the specified assessment type. in: query name: type x-default-description: An optional filter to return only items that match the specified assessment type. schema: type: string enum: - LATEST - SAVED - COMPARTMENT - SAVE_SCHEDULE PasswordLastChangedLessThanQueryParam: description: 'A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timePasswordLastChangedLessThan required: false x-default-description: An optional filter to return users whose last password change in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time MaskingColumnLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle states. in: query name: maskingColumnLifecycleState required: false x-default-description: Fetch all masking columns regardless of their lifeCycleState. x-obmcs-top-level-enum: '#/definitions/MaskingColumnLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - NEEDS_ATTENTION - FAILED CompartmentIdentifierPathParam: description: The OCID of the compartment. in: path name: compartmentId required: true schema: type: string maxLength: 100 minLength: 1 SecurityPolicyLifecycleStateQueryParam: description: The current state of the security policy. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityPolicyLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - FAILED - DELETING - DELETED SqlFirewallAllowedSqlSCIMQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** query=(currentUser eq "SCOTT") and (topLevel eq "YES") ' in: query name: scimQuery required: false x-default-description: 'null' schema: type: string maxLength: 2048 minLength: 1 SchemaNameQueryParam: description: A filter to return only items related to specific schema name. in: query name: schemaName required: false x-default-description: - null style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string TargetsWithExternalAuthenticationQueryParam: description: A filter to return only the targets with the DB security feature - External Authentication enabled/disabled. in: query name: targetsWithExternalAuthentication x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE AlertSCIMQueryParam: description: "The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2\nof the System for Cross-Domain Identity Management (SCIM) specification, which is available\nat [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions,\ntext, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format.\n(Numeric and boolean values should not be quoted.)\n\n**Example:** |\n(timeCreated ge \"2021-06-04T01:00:26.000Z\") and (targetNames eq \"target_1\")\n(featureDetails.userName eq \"user\") and (targetNames eq \"target_1\")\nSupported fields:\nseverity\nstatus\nalertType\ntargetIds\ntargetNames\noperationTime\nlifecycleState\ndisplayName\ntimeCreated\ntimeUpdated\nfeatureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - \nuserName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)\n" in: query name: scimQuery required: false x-default-description: 'An optional query parameter to filter alerts based on a SCIM query. ' schema: type: string maxLength: 2048 minLength: 1 DiscoveryAnalyticsGroupBy: description: Attribute by which the discovery analytics data should be grouped. in: query name: groupBy x-default-description: Fetches analytics data without grouping by a specific dimension. schema: type: string enum: - targetId - sensitiveDataModelId - sensitiveTypeId - targetIdAndSensitiveDataModelId - sensitiveTypeIdAndTargetId - sensitiveTypeIdAndSensitiveDataModelId SecurityAssessmentLifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityAssessmentLifecycleState' schema: type: string enum: - CREATING - SUCCEEDED - UPDATING - DELETING - DELETED - FAILED SecurityAssessmentTriggeredByQueryParam: description: A filter to return only security assessments that were created by either user or system. in: query name: triggeredBy x-default-description: An optional filter to return only security assessments that were created by either user or system. schema: type: string enum: - USER - SYSTEM SensitiveTypeGroupIdPathParam: description: The OCID of the sensitive type group. in: path name: sensitiveTypeGroupId required: true schema: type: string maxLength: 255 minLength: 1 SensitiveTypesExportIdPathParam: description: The OCID of the sensitive types export. in: path name: sensitiveTypesExportId required: true schema: type: string maxLength: 255 minLength: 1 AlertSummaryFieldQueryParam: description: Specifies a subset of summarized fields to be returned in the response. in: query name: summaryField required: false x-default-description: Specifies a subset of summarized fields to be returned in the response. style: form explode: true schema: type: array items: enum: - alertType - targetIds - targetNames - alertSeverity - alertStatus - timeCreated - policyId - open - closed - critical - high - medium - low - alertcount - throttled type: string AuditEventPaginationLimitQueryParam: description: 'For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit required: false x-default-description: 'For list pagination. The maximum number of items to return per page in a paginated "List" call. ' schema: type: integer maximum: 10000 minimum: 1 SecurityPolicyReportIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the security policy report resource. in: query name: securityPolicyReportId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 GroupByQueryParam: description: 'A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. ' in: query name: groupBy required: false x-default-description: The name of the field the audit event summary should be grouped by. style: form explode: true schema: type: array items: enum: - auditEventTime - dbUserName - targetId - targetName - targetClass - objectType - clientHostname - clientProgram - clientId - auditType - eventName - objectOwner - auditPolicies - objectName - osUserName - errorCode - clientIp - externalUserId type: string DatabaseSecurityConfigIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the database security configuration resource. in: query name: databaseSecurityConfigId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IsCaseInSensitive: description: 'A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search. ' in: query name: isCaseInSensitive required: false x-default-description: false schema: type: boolean AuditPolicyGroupByQueryParam: description: The group by parameter to summarize audit policy aggregation. in: query name: groupBy x-default-description: 'null' style: form explode: true schema: type: array items: enum: - auditPolicyCategory - auditPolicyName - targetId type: string TargetDatabaseIdQueryParam: description: A filter to return the target database that matches the specified OCID. in: query name: targetDatabaseId required: false schema: type: string maxLength: 255 minLength: 1 StatusQueryParam: description: A filter to return only the sensitive columns that match the specified status. in: query name: status required: false x-default-description: Fetch all sensitive columns regardless of their status. style: form explode: true schema: type: array items: enum: - VALID - INVALID type: string IsResultAppliedQueryParam: description: A filter to return the discovery result resources based on the value of their isResultApplied attribute. in: query name: isResultApplied required: false x-default-description: Fetch all discovery jobs regardless of their result applied status. schema: type: boolean reportDefinitionIdPathParam: description: Unique report definition identifier in: path name: reportDefinitionId required: true schema: type: string maxLength: 255 minLength: 1 UserRoleQueryParam: description: A filter to return only items that match the specified user role. in: query name: userRole x-default-description: An optional filter to return only items that match the specified user role. schema: type: string maxLength: 50 minLength: 1 DiscoveryLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: Fetch all discovery resources regardless of their lifecycle state. x-obmcs-top-level-enum: '#/definitions/DiscoveryLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED SecurityPolicyEntryStateIdPathParam: description: "Unique security policy entry state identifier.\nThe unique id for a given security policy entry state can be obtained \nfrom the list api by passing the OCID of the corresponding \nsecurity policy deployment resource as the query parameter.\n" in: path name: securityPolicyEntryStateId required: true schema: type: string maxLength: 255 minLength: 1 SecurityPolicyConfigLifecycleStateQueryParam: description: The current state of the security policy configuration resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityPolicyConfigLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - FAILED - NEEDS_ATTENTION - DELETING - DELETED TimeEndQueryParam: description: 'An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeEnded required: false x-default-description: 'An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' schema: type: string format: date-time DefaultMaskingFormatIdQueryParam: description: A filter to return only the sensitive types that have the default masking format identified by the specified OCID. in: query name: defaultMaskingFormatId required: false x-default-description: Fetch all sensitive types regardless of their default masking format. schema: type: string maxLength: 255 minLength: 1 TrailLocationQueryParam: description: The audit trail location. in: query name: trailLocation required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ReportMimeTypeQueryParam: description: An optional filter to return only resources that match the specified mime type. in: query name: mimeType required: false x-default-description: 'null' schema: type: string enum: - PDF - XLS - JSON SecurityAssessmentIdPathParam: description: The OCID of the security assessment. in: path name: securityAssessmentId required: true schema: type: string maxLength: 255 minLength: 1 MembershipIdQueryParam: description: A filter to return the target database only if it is a member of the target database group. in: query name: targetDatabaseId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RoleAuthTypeQueryParam: description: A filter to return roles based on authentication type. in: query name: authenticationType required: false x-default-description: 'null' schema: type: string maxLength: 128 minLength: 1 MaskingColumnKeyPathParam: description: The unique key that identifies the masking column. It's numeric and unique within a masking policy. in: path name: maskingColumnKey required: true schema: type: string maxLength: 255 minLength: 1 TimeCreatedLessThanQueryParam: description: 'Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeCreatedLessThan required: false x-default-description: An optional filter to return resources that were created before a specific date. schema: type: string format: date-time SqlFirewallViolationSummarySortByQueryParam: description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' in: query name: sortBy required: false x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' schema: type: string enum: - dbUserName - targetId - targetName - operationTime - timeCollected - clientOsUserName - operation - currentDbUserName - sqlLevel - clientIp - clientProgram - violationCause - violationAction - violationCount default: operationTime AlertIdQueryParam: description: A filter to return alert by it's OCID. in: query name: id required: false x-default-description: An optional filter to return alert by it's OCID. schema: type: string maxLength: 255 minLength: 1 TargetsWithGlobalAuthenticationQueryParam: description: A filter to return only the targets with the DB security feature - Global Authentication enabled/disabled. in: query name: targetsWithGlobalAuthentication x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE TargetsWithColumnEncryptionQueryParam: description: A filter to return only the targets that enable the DB security feature - Column Encryption enabled/disabled. in: query name: targetsWithColumnEncryption x-default-description: 'null' schema: type: string enum: - ENABLED - DISABLED - NONE InfrastructureTypeQueryParam: description: A filter to return only target databases that match the specified infrastructure type. in: query name: infrastructureType x-default-description: A filter to return only target databases that match the specified infrastructure type. x-obmcs-top-level-enum: '#/definitions/InfrastructureType' schema: type: string enum: - ORACLE_CLOUD - CLOUD_AT_CUSTOMER - ON_PREMISES - NON_ORACLE_CLOUD RegistrationPolicyIdPathParam: description: The OCID of the registration policy to be used for identification in: path name: registrationPolicyId required: true schema: type: string maxLength: 255 minLength: 1 FindingTitleQueryParam: description: The unique title that identifies the finding. It is a string and unique within a security assessment. in: query name: findingTitle required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the Unified Audit policy resource. in: query name: unifiedAuditPolicyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 InactiveAccountTimeGreaterThanOrEqualQueryParam: description: 'An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: inactiveAccountTimeGreaterThanOrEqual required: false x-default-description: An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. schema: type: string SensitiveColumnGroupByQueryParam: description: The group by parameter to summarize the sensitive columns. in: query name: groupBy x-default-description: 'The group by parameter to summarize the sensitive columns. ' style: form explode: true schema: type: array items: enum: - targetId - sensitiveTypeId - sensitiveDataModelId type: string ArchiveRetrievalLifecycleStateQueryParam: description: A filter to return only resources that matches the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/AuditArchiveRetrievalLifecycleState' schema: type: string enum: - CREATING - ACTIVE - NEEDS_ATTENTION - FAILED - DELETING - DELETED - UPDATING WorkRequestSortOrderQueryParam: description: The sorting order for the work requests, either ascending (ASC) or descending (DESC). in: query name: sortOrder schema: type: string enum: - ASC - DESC default: DESC ObjectNameQueryParam: description: A filter to return only items related to a specific object name. in: query name: objectName required: false x-default-description: - null style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string ParentColumnKeyQueryParam: description: A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys. in: query name: parentColumnKey required: false x-default-description: Fetch all sensitive columns regardless of their parent column keys. style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string RegistrationPolicyConnectionTypeQueryParam: description: Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT. in: query name: connectionType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/PolicyConnectionOption/connectionType' schema: type: string MaskingObjectSortByQueryParam: description: "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" in: query name: sortBy schema: type: string enum: - schemaName - objectName - objectType default: schemaName UserAssessmentTargetTypeQueryParam: description: A filter to return only only target database resources or target database group resources. in: query name: targetType x-default-description: An optional filter to return only target database resources or target database group resources. x-obmcs-top-level-enum: '#/definitions/UserAssessmentTargetType' schema: type: string enum: - TARGET_DATABASE - TARGET_DATABASE_GROUP AttributeSetTypeQueryParam: description: A filter to return only attribute set resources that matches the specified attribute set type query param. in: query name: attributeSetType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AttributeSet/attributeSetType' schema: type: string MaskingSchemaSortByQueryParam: description: "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" in: query name: sortBy schema: type: string enum: - schemaName default: schemaName LibraryMaskingFormatSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated - timeUpdated - lifecycleState default: timeCreated SqlCollectionLifecycleStateQueryParam: description: The current state of the SQL collection. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SqlCollectionLifecycleState' schema: type: string enum: - CREATING - UPDATING - COLLECTING - COMPLETED - INACTIVE - FAILED - DELETING - DELETED - NEEDS_ATTENTION TimeCreatedGreaterThanOrEqualToQueryParam: description: 'A filter to return only the resources that were created after the specified date and time, as defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date. **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeCreatedGreaterThanOrEqualTo required: false schema: type: string format: date-time MaskingPolicySortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. The displayName sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated OnPremConnectorIdQueryParam: description: A filter to return only the on-premises connector that matches the specified id. in: query name: onPremConnectorId required: false schema: type: string maxLength: 255 minLength: 1 MaskingPolicyHealthReportSortByQueryParam: description: sort by in: query name: sortBy required: false schema: type: string enum: - displayName - timeCreated default: timeCreated summaryFieldQueryParam: description: Specifies a subset of summarized fields to be returned in the response. in: query name: summaryField required: false x-default-description: Specifies a subset of summarized fields to be returned in the response. style: form explode: true schema: type: array items: enum: - auditEventTime - dbUserName - targetId - targetName - targetClass - objectType - clientHostname - clientProgram - clientId - auditType - eventName - allRecord - auditSettingsChange - dbSchemaChange - entitlementChange - loginFailure - loginSuccess - allViolations - realmViolations - ruleViolations - dvconfigActivities - ddls - dmls - privilegeChanges - auditSettingsEnables - auditSettingsDisables - selects - creates - alters - drops - grants - revokes - objectOwner - auditPolicies - objectName - osUserName - errorCode - clientIp - externalUserId type: string ArchiveRetrievalTimeOfExpiryQueryParam: description: The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival. in: query name: timeOfExpiry required: false x-default-description: The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival. schema: type: string format: date-time maxLength: 128 minLength: 1 AuditEventSortByQueryParam: description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' in: query name: sortBy required: false x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' schema: type: string enum: - dbUserName - targetName - databaseType - targetClass - auditEventTime - timeCollected - osUserName - operation - operationStatus - eventName - errorCode - errorMessage - objectType - objectName - objectOwner - clientHostname - clientIp - isAlerted - actionTaken - clientProgram - commandText - commandParam - extendedEventAttributes - auditLocation - osTerminal - clientId - auditPolicies - auditType - externalUserId default: auditEventTime maxLength: 128 minLength: 0 IsSeedRequiredQueryParam: description: 'A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format. ' in: query name: isSeedRequired required: false schema: type: boolean default: false TableNameContainsQueryParam: description: A filter to return only items if table name contains a specific string. in: query name: tableNameContains required: false x-default-description: 'null' schema: type: string SqlFirewallPolicyTimeStartQueryParam: description: 'An optional filter to return the summary of the SQL Firewall policies created after the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeStarted required: false x-default-description: 'null' schema: type: string format: date-time WorkRequestTargetDatabaseIdQueryParam: description: A filter to return only work requests that are associated to the specified target database OCID. in: query name: targetDatabaseId required: false schema: type: string maxLength: 255 minLength: 1 UserAssessmentIdPathParam: description: The OCID of the user assessment. in: path name: userAssessmentId required: true schema: type: string maxLength: 255 minLength: 1 ReportTypeQueryParam: description: An optional filter to return only resources that match the specified type. in: query name: type x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ReportType' schema: type: string enum: - GENERATED - SCHEDULED ReportScimQueryParam: description: 'The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at [RFC3339](https://tools.ietf.org/html/draft-ietf-scim-api-12). In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) **Example:** query=(auditEventTime ge "2021-06-04T01:00:26.000Z") and (eventName eq "LOGON") ' in: query name: scimQuery required: false x-default-description: 'An optional query parameter to filter audit event records in the generated report based on a SCIM query. ' schema: type: string maxLength: 2048 minLength: 1 SecurityPolicyConfigIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the security policy configuration resource. in: query name: securityPolicyConfigId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyIdPathParam: description: The OCID of the Unified Audit policy resource. in: path name: unifiedAuditPolicyId required: true schema: type: string maxLength: 255 minLength: 1 TimePasswordExpiryLessThanQueryParam: description: 'A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timePasswordExpiryLessThan required: false x-default-description: An optional filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time DiscoveryJobSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeStarted - displayName default: timeStarted EntityTypeQueryParam: description: A filter to return the sensitive type resources based on the value of their entityType attribute. in: query name: entityType required: false x-default-description: Fetch sensitive types and categories. x-obmcs-top-level-enum: '#/definitions/SensitiveTypeEntity' schema: type: string enum: - SENSITIVE_TYPE - SENSITIVE_CATEGORY RequestIdHeader: description: Unique identifier for the request. in: header name: opc-request-id schema: type: string TimeZoneQueryParam: description: 'Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. ' in: query name: queryTimeZone required: false x-default-description: Specifies the time zone. schema: type: string format: x-obmcs-time-zone default: UTC IsSecurityAssessmentBaselineQueryParam: description: A filter to return only the security assessments that are set as a baseline. in: query name: isBaseline schema: type: boolean default: false SdmMaskingPolicyDifferenceColumnSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for schemaName is descending. The default order for differenceType, schemaName, objectName, columnName and plannedAction is ascending. ' in: query name: sortBy schema: type: string enum: - differenceType - schemaName - objectName - columnName - plannedAction default: schemaName SecurityPolicyEntryIdQueryParam: description: An optional filter to return only resources that match the specified security policy entry OCID. in: query name: securityPolicyEntryId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CategoryQueryParam: description: The category of the finding. in: query name: category x-default-description: Fetch all findings regardless of their category. schema: type: string maxLength: 100 minLength: 1 SessionsPerUserLessThanQueryParam: description: 'An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: sessionsPerUserLessThan required: false x-default-description: 'An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. ' schema: type: string AccessLevelQueryParam: description: 'Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. ' in: query name: accessLevel schema: type: string enum: - RESTRICTED - ACCESSIBLE default: RESTRICTED SortByQueryParam: description: 'The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED TargetDatabaseGroupsSortByQueryParam: description: 'The sorting field for your request. You can only specify a single sorting order (sortOrder). The default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - lifecycleState - membershipUpdateTime default: timeCreated libraryMaskingFormatIdPathParam: description: The OCID of the library masking format. in: path name: libraryMaskingFormatId required: true schema: type: string maxLength: 255 minLength: 1 UnifiedAuditPolicyDefinitionIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource. in: query name: unifiedAuditPolicyDefinitionId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MaskingErrorStepNameQueryParam: description: A filter to return only masking errors that match the specified step name. in: query name: stepName required: false x-default-description: Fetch errors from all masking steps. schema: type: string enum: - VALIDATE - GENERATE_SCRIPT - EXECUTE_MASKING - PRE_MASKING - POST_MASKING TargetAlertPolicyAssociationSortByQueryParam: description: 'The field to sort by. Only one sort parameter may be provided. ' in: query name: sortBy required: false schema: type: string enum: - DISPLAYNAME - TIMECREATED - TIMEUPDATED default: TIMECREATED MaskingPolicyHealthReportLogMessageTypeQueryParam: description: A filter to return only the resources that match the specified log message type. in: query name: messageType required: false x-default-description: Fetch all messages regardless of the message type. schema: type: string enum: - PASS - WARNING - ERROR RoleTypeQueryParam: description: A filter to return roles based on whether they are maintained by oracle or not. in: query name: isOracleMaintained required: false x-default-description: 'null' schema: type: boolean TopFindingStatusQueryParam: description: An optional filter to return only the top finding that match the specified status. in: query name: topFindingStatus x-default-description: 'null' x-obmcs-enumref: '#/definitions/FindingAnalyticsDimensions/topFindingStatus' schema: type: string VcnIdQueryParam: description: A filter to return only resources that match the specified VCN OCID. in: query name: vcnId required: false schema: type: string maxLength: 255 minLength: 1 DataSafePrivateEndpointIdentifierPathParam: description: The OCID of the private endpoint. in: path name: dataSafePrivateEndpointId required: true schema: type: string AttributeSetAssociatedResourceTypeQueryParam: description: A filter to return attribute set associated resources that matches the specified resource type query param. in: query name: associatedResourceType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AssociatedResourceSummary/associatedResourceType' schema: type: string ReferentialRelationsPaginationLimitQueryParam: description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit x-default-description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). schema: type: integer maximum: 500 minimum: 1 TimeGeneratedGreaterThanOrEqualToQueryParam: description: 'A filter to return only the resources that were generated after the specified date and time, as defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Using TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date. **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timeGeneratedGreaterThanOrEqualTo required: false schema: type: string format: date-time PasswordLockTimeLessThanQueryParam: description: 'An optional filter to return the profiles having password lock number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: passwordLockTimeLessThan required: false x-default-description: An optional filter to return the profiles having password lock number less than the provided value. schema: type: string DiscoveryResultSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending. ' in: query name: sortBy schema: type: string enum: - discoveryType - timeFinished - schemaName - objectName - columnName - plannedAction default: timeFinished TargetDatabaseIdPathParam: description: The OCID of the Data Safe target database. in: path name: targetDatabaseId required: true schema: type: string DifferenceTypeQueryParam: description: A filter to return only the SDM masking policy difference columns that match the specified difference type in: query name: differenceType required: false x-default-description: Fetch all SDM masking policy difference columns regardless of their difference type. x-obmcs-enumref: '#/definitions/SdmMaskingPolicyDifference/differenceType' schema: type: string SqlFirewallAllowedSqlIdPathParam: description: The OCID of the sqlFirewallAllowedSql resource. in: path name: sqlFirewallAllowedSqlId required: true schema: type: string maxLength: 255 minLength: 1 AreAllSchemasAccessibleQueryParam: description: A filter to return only items that match the criteria that all schemas can be accessed by a user. in: query name: areAllSchemasAccessible x-default-description: 'null' schema: type: boolean DisplayNameQueryParam: description: 'A filter to return only resources that match the specified display name. ' in: query name: displayName x-default-description: A filter to return only resources that match the specified display name. schema: type: string maxLength: 255 minLength: 1 SecurityPolicyDeploymentLifecycleStateQueryParam: description: The current state of the security policy deployment. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityPolicyDeploymentLifecycleState' schema: type: string enum: - CREATING - UPDATING - DEPLOYED - PENDING_DEPLOYMENT - NEEDS_ATTENTION - FAILED - DELETING - DELETED AuditTrailGroupByQueryParam: description: The group by parameter for summarize operation on audit trail. in: query name: groupBy x-default-description: 'null' style: form explode: true schema: type: array items: enum: - location - lifecycleState - status - targetId type: string AttributeSetLifecycleStateQueryParam: description: The current state of an attribute set. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AttributeSet/lifecycleState' schema: type: string MaskingLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle states. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/MaskingLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - NEEDS_ATTENTION - FAILED PaginationTokenQueryParam: description: For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: page x-default-description: The page token representing the page at which to start retrieving results. schema: type: string maxLength: 1024 minLength: 1 MonthInConsiderationLessThanQueryParam: description: 'Specifying `monthInConsiderationLessThan` parameter will retrieve all items for which the event month is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T00:00:00.000Z ' in: query name: monthInConsiderationLessThan required: false x-default-description: 'An optional filter to return items whose event month is less than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' schema: type: string format: date-time LibraryMaskingFormatIdQueryParam: description: A filter to return only the resources that match the specified library masking format OCID. in: query name: libraryMaskingFormatId required: false schema: type: string maxLength: 255 minLength: 1 SqlCollectionLogGroupByQueryParam: description: The group by parameter to summarize SQL collection log insights aggregation. in: query name: groupBy x-default-description: 'null' schema: type: string enum: - clientIp - clientProgram - clientOsUserName SensitiveDataModelIdQueryParam: description: A filter to return only the resources that match the specified sensitive data model OCID. in: query name: sensitiveDataModelId required: false x-default-description: Fetch items including all sensitive data models. schema: type: string maxLength: 255 minLength: 1 UserKeyPathParam: description: The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user. in: path name: userKey required: true schema: type: string SqlCollectionUserNameQueryParam: description: A filter to return only items that match the specified user name. in: query name: dbUserName x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 DatatypeQueryParam: description: A filter to return only items related to specific datatype. in: query name: datatype required: false x-default-description: - null style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string SecurityPolicyEntryStateDeploymentStatusQueryParam: description: The current state of the security policy deployment. in: query name: deploymentStatus x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SecurityPolicyEntryStateDeploymentStatus' schema: type: string enum: - CREATED - MODIFIED - CONFLICT - CONNECTIVITY_ISSUE - UNSUPPORTED_SYNTAX - UNKNOWN_ERROR - UNAUTHORIZED - DELETED MonthInConsiderationGreaterThanQueryParam: description: 'Specifying `monthInConsiderationGreaterThan` parameter will retrieve all items for which the event month is greater than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T00:00:00.000Z ' in: query name: monthInConsiderationGreaterThan required: false x-default-description: 'An optional filter to return items whose event month is greater than the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' schema: type: string format: date-time DryRunHeader: description: 'Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. ' in: header name: opc-dry-run required: false schema: type: boolean default: false TableNameQueryParam: description: A filter to return only items related to specific table name. in: query name: tableName required: false x-default-description: - null style: form explode: true schema: type: array items: maxLength: 128 minLength: 1 type: string CheckSortByQueryParam: description: 'The field to sort by. You can specify only one sort order(sortOrder). The default order for title is ascending. ' in: query name: sortBy required: false schema: type: string enum: - title - category - key default: title ViewAccessEntrySortByQueryParam: description: 'The field to sort by. Only one sort parameter should be provided. ' in: query name: sortBy required: false x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value. ' schema: type: string enum: - key - grantee - accessType - tableSchema - tableName - viewSchema - viewName - privilegeType - privilege - privilegeGrantable - grantFromRole - accessThroughObject - columnName - grantor - isAccessConstrainedByDatabaseVault - isAccessConstrainedByVirtualPrivateDatabase - isAccessConstrainedByRedaction - isAccessConstrainedByRealApplicationSecurity - isAccessConstrainedBySqlFirewall default: key FailedLoginAttemptsLessThanQueryParam: description: 'An optional filter to return the profiles having failed login attempts number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: failedLoginAttemptsLessThan required: false x-default-description: An optional filter to return the profiles having failed login attempts number less than the provided value. schema: type: string GrantedRoleQueryParam: description: A filter to return only items that match the specified role. in: query name: grantedRole required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SensitiveTypesExportLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: Fetch all sensitive types export resources regardless of their lifecycle state. x-obmcs-top-level-enum: '#/definitions/SensitiveTypesExportLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED AuditCollectedVolumeGreaterThanOrEqualToQueryParam: description: A filter to return only items that have count of audit records collected greater than or equal to the specified value. in: query name: auditCollectedVolumeGreaterThanOrEqualTo schema: type: integer format: int64 ArchiveRetrievalTargetIdQueryParam: description: The OCID of the target associated with the archive retrieval. in: query name: targetId required: false schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 SecurityAssessmentSortByQueryParam: description: 'The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - timeLastAssessed - timeUpdated default: timeCreated DepthLevelQueryParam: description: A filter to return only items that match the specified user grant depth level. in: query name: depthLevel x-default-description: An optional filter to return only items that match the specified user grant depth level. schema: type: integer format: int32 AlertPolicyLifecycleStateQueryParam: description: An optional filter to return only alert policies that have the given life-cycle state. in: query name: lifecycleState required: false x-default-description: An optional filter to return only alert policies that have the given life-cycle state. x-obmcs-top-level-enum: '#/definitions/AlertPolicyLifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED IsSeededQueryParam: description: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. in: query name: isSeeded required: false x-default-description: null schema: type: boolean default: false RegistrationPoliciesEnablementLevelQueryParam: description: Filter registration policies by resource type. in: query name: enablementLevel required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/RegistrationPolicy/enablementLevel' schema: type: string SecurityAssessmentContainsOracleDefinedSeverityQueryParam: description: A filter to return only findings that match the specified risk level(s). Use containsOracleDefinedSeverity parameter if need to filter by one or multiple risk levels. in: query name: containsOracleDefinedSeverity x-default-description: Fetch all findings regardless of their Oracle Defined Severity. style: form explode: true schema: type: array items: enum: - HIGH - MEDIUM - LOW - EVALUATE - ADVISORY - PASS - DEFERRED type: string maxItems: 30 FindingsRiskChangeSortByQueryParam: description: 'The field to sort by. You can specify only one sort order(sortOrder). The default order for timeUpdated is descending. ' in: query name: sortBy required: false schema: type: string enum: - timeUpdated - modifiedBy - isRiskDeferred - timeValidUntil default: timeUpdated GrantNameQueryParam: description: A filter to return only items that match the specified user grant name. in: query name: grantName x-default-description: An optional filter to return only items that match the specified user grant name. schema: type: string ComparisonSecurityAssessmentIdPathParam: description: The OCID of the security assessment baseline. in: path name: comparisonSecurityAssessmentId required: true schema: type: string maxLength: 255 minLength: 1 ReportDefinitionSortByQueryParam: description: 'The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy schema: type: string enum: - TIMECREATED - DISPLAYNAME - DISPLAYORDER default: TIMECREATED SensitiveDataModelSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated MaskingColumnGroupQueryParam: description: A filter to return only the resources that match the specified masking column group. in: query name: maskingColumnGroup required: false x-default-description: Fetch masking columns belonging to all column groups. style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string UserKeyQueryParam: description: A filter to return only items that match the specified user key. in: query name: userKey x-default-description: An optional filter to return only items related to a specific user key. schema: type: string AttributeSetIdQueryParam: description: A filter to return only attribute set resources that matches the specified attribute set OCID query param. in: query name: attributeSetId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PeerTargetDatabaseIdPathParam: description: The unique id of the peer target database. in: path name: peerTargetDatabaseId required: true schema: type: integer SessionsPerUserGreaterThanOrEqualQueryParam: description: 'An optional filter to return the profiles permitting the user to spawn multiple sessions having count. greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: sessionsPerUserGreaterThanOrEqual required: false x-default-description: 'An optional filter to return the profiles permitting the user to spawn multiple sessions having count greater than or equal to the provided value. ' schema: type: string PasswordLockTimeGreaterThanOrEqualQueryParam: description: 'An optional filter to return the profiles having password lock number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values. ' in: query name: passwordLockTimeGreaterThanOrEqual required: false x-default-description: An optional filter to return the profiles having password lock number greater than or equal to the provided value. schema: type: string SqlCollectionTimeEndQueryParam: description: 'An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeEnded required: false x-default-description: 'null' schema: type: string format: date-time SqlCollectionIdQueryParam: description: An optional filter to return only resources that match the specified OCID of the SQL collection resource. in: query name: sqlCollectionId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MaskedColumnSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending. ' in: query name: sortBy required: false schema: type: string enum: - schemaName - objectName - sensitiveTypeId - maskingColumnGroupId default: schemaName SdmMaskingPolicyDifferenceIdPathParam: description: The OCID of the SDM masking policy difference. in: path name: sdmMaskingPolicyDifferenceId required: true schema: type: string maxLength: 255 minLength: 1 SqlCollectionTimeStartQueryParam: description: 'An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeStarted required: false x-default-description: 'null' schema: type: string format: date-time PasswordLastChangedGreaterThanOrEqualToQueryParam: description: 'A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). **Example:** 2016-12-19T16:39:57.600Z ' in: query name: timePasswordLastChangedGreaterThanOrEqualTo required: false x-default-description: An optional filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). schema: type: string format: date-time SqlFirewallAllowedSqlGroupByQueryParam: description: The group by parameter to summarize the allowed SQL aggregation. in: query name: groupBy x-default-description: 'The group by parameter to summarize the allowed SQL aggregation. If not specified, the response will be grouped by sqlFirewallPolicyId which is the default. ' style: form explode: true schema: type: array items: enum: - dbUserName - sqlLevel - sqlFirewallPolicyId - lifecycleState type: string SensitiveTypeGroupSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated UnifiedAuditPolicyCategoryQueryParam: description: The category to which the unified audit policy definition belongs to. in: query name: unifiedAuditPolicyCategory x-default-description: 'null' x-obmcs-enumref: '#/definitions/UnifiedAuditPolicyDefinition/auditPolicyCategory' schema: type: string SensitiveColumnSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - schemaName - objectName - columnName - dataType default: timeCreated SecurityPolicyConfigIdPathParam: description: The OCID of the security policy configuration resource. in: path name: securityPolicyConfigId required: true schema: type: string maxLength: 255 minLength: 1 SqlFirewallPolicyViolationActionQueryParam: description: An optional filter to return only resources that match the specified violation action. in: query name: violationAction x-default-description: 'null' schema: type: string enum: - block - observe SensitiveSchemaSortByQueryParam: description: "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" in: query name: sortBy schema: type: string enum: - schemaName default: schemaName SqlFirewallViolationGroupByQueryParam: description: 'A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. ' in: query name: groupBy required: false x-default-description: The name of the field the SQL violation summary should be grouped by. style: form explode: true schema: type: array items: enum: - dbUserName - targetName - operationTime - timeCollected - clientOsUserName - operation - sqlText - currentDbUserName - sqlLevel - clientIp - clientProgram - violationCause - violationAction type: string ArchiveRetrievalPaginationLimitQueryParam: description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit x-default-description: For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). schema: type: integer maximum: 200 minimum: 0 SecurityPolicyTypeQueryParam: description: The type of the security policy. in: query name: securityPolicyType x-obmcs-enumref: '#/definitions/SecurityPolicy/securityPolicyType' schema: type: string default: DATASAFE_MANAGED SqlCollectionLogInsightsTimeEndQueryParam: description: 'An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' in: query name: timeEnded required: true x-default-description: 'null' schema: type: string format: date-time DepthLevelGreaterThanOrEqualToQueryParam: description: A filter to return only items that are at a level greater than or equal to the specified user grant depth level. in: query name: depthLevelGreaterThanOrEqualTo x-default-description: An optional filter to return only items that are at a level greater than or equal to the specified user grant depth level. schema: type: integer format: int32 MaskingReportSortByQueryParam: description: 'The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending. ' in: query name: sortBy required: false schema: type: string enum: - timeMaskingFinished default: timeMaskingFinished AlertPolicyIdPathParam: description: The OCID of the alert policy. in: path name: alertPolicyId required: true schema: type: string maxLength: 255 minLength: 1 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' maxProperties: 25 type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' maxProperties: 10 type: object systemTags: additionalProperties: additionalProperties: description: 'Value of the tag (only string, integer, and boolean types are supported). ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-headers: Sunset: description: Sunset date when this operation will stop working, in format, e.g. "Wed, 11 Nov 2026 11:11:11 GMT" type: string etag: description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven) ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request. ' type: string retry-after: description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. format: int32 type: integer x-properties: arrayOfMaps: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: additionalProperties: type: object type: object type: array definedTags: additionalProperties: additionalProperties: description: 'Value of the tag; only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` ' type: object listOfObjects: description: 'List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` ' items: type: object type: array map: additionalProperties: type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object mapOfMaps: additionalProperties: additionalProperties: description: 'Value of the map as key-pair values. Example: `{"critical": "users"}` ' type: object description: 'Key-value pair that represents the top level map. Example: `{"statistics": "critical"}` ' type: object description: "Map that contains maps of values.\n Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n" type: object reportFormat: default: PDF description: Format of the report. enum: - PDF - XLS example: PDF type: string x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.ds.cp