{ "opencollection": "1.0.0", "info": { "name": "Data Safe API", "version": "20181201" }, "items": [ { "info": { "name": "dataSafe", "type": "folder" }, "items": [ { "info": { "name": "Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/actions/downloadPrivilegeScript", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ] }, "docs": "Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.\n" }, { "info": { "name": "Returns the aggregation details of the alerts.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alertAnalytics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "queryTimeZone", "value": "", "type": "query", "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.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "scimQuery", "value": "", "type": "query", "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" }, { "name": "summaryField", "value": "", "type": "query", "description": "Specifies a subset of summarized fields to be returned in the response." }, { "name": "groupBy", "value": "", "type": "query", "description": "A groupBy can only be used in combination with summaryField parameter.\nA groupBy value has to be a subset of the values mentioned in summaryField parameter.\n" } ] }, "docs": "Returns the aggregation details of the alerts.\n" }, { "info": { "name": "Gets a list of all alert policies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alertPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alertPolicyId", "value": "", "type": "query", "description": "A filter to return policy by it's OCID." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter to return only alert policies of a certain type." }, { "name": "isUserDefined", "value": "", "type": "query", "description": "An optional filter to return only alert policies that are user-defined or not." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "An optional filter to return only alert policies that have the given life-cycle state." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter may be provided.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of all alert policies.\n" }, { "info": { "name": "Gets the details of the specified alert policy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alertPolicies/:alertPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alertPolicyId", "value": "", "type": "path", "description": "The OCID of the alert policy." } ] }, "docs": "Gets the details of alert policy by its ID." }, { "info": { "name": "Lists the rules of the specified alert policy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alertPolicies/:alertPolicyId/rules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alertPolicyId", "value": "", "type": "path", "description": "The OCID of the alert policy." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "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.\nIf there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.\n" }, { "info": { "name": "Gets a list of all alerts.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alerts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A filter to return alert by it's OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "scimQuery", "value": "", "type": "query", "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" }, { "name": "field", "value": "", "type": "query", "description": "Specifies a subset of fields to be returned in the response." } ] }, "docs": "Gets a list of all alerts.\n" }, { "info": { "name": "Patch alerts.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/alerts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of one or more alert specified by the alert IDs." }, { "info": { "name": "Updates alerts in the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/alerts/actions/updateAll", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates alerts in the specified compartment." }, { "info": { "name": "Gets the details of the specified alerts.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/alerts/:alertId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alertId", "value": "", "type": "path", "description": "The OCID of alert." } ] }, "docs": "Gets the details of the specified alerts." }, { "info": { "name": "Updates the status of the specified alert.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/alerts/:alertId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alertId", "value": "", "type": "path", "description": "The OCID of alert." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of the specified alert." }, { "info": { "name": "Moves the specified alert into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/alerts/:alertId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "alertId", "value": "", "type": "path", "description": "The OCID of alert." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified alert into a different compartment." }, { "info": { "name": "Returns the list of attribute sets.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/attributeSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "attributeSetId", "value": "", "type": "query", "description": "A filter to return only attribute set resources that matches the specified attribute set OCID query param." }, { "name": "attributeSetType", "value": "", "type": "query", "description": "A filter to return only attribute set resources that matches the specified attribute set type query param." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of an attribute set." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "isUserDefined", "value": "", "type": "query", "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." }, { "name": "inUse", "value": "", "type": "query", "description": "A filter to return attribute set resources that are in use by other associated resources." } ] }, "docs": "Retrieves the list of attribute sets.\n\nThe ListAttributeSets operation returns only the attribute sets in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequester has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid only when\n`compar" }, { "info": { "name": "Creates an attribute set.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/attributeSets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an attribute set.\n" }, { "info": { "name": "Gets the details of the specified attribute set.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/attributeSets/:attributeSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "attributeSetId", "value": "", "type": "path", "description": "OCID of an attribute set." } ] }, "docs": "Gets the details of the specified attribute set." }, { "info": { "name": "Updates an attribute set.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/attributeSets/:attributeSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "attributeSetId", "value": "", "type": "path", "description": "OCID of an attribute set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an attribute set." }, { "info": { "name": "Submits a work request to delete an attribute set.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/attributeSets/:attributeSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "attributeSetId", "value": "", "type": "path", "description": "OCID of an attribute set." } ] }, "docs": "Submits a work request to delete an attribute set.\n" }, { "info": { "name": "Moves the attribute set to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/attributeSets/:attributeSetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "attributeSetId", "value": "", "type": "path", "description": "OCID of an attribute set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the attribute set to the specified compartment. When provided, if-Match is checked against ETag value of the resource.\n" }, { "info": { "name": "Returns list of all associated resources of the attribute set identified by the attribute set id passed as path parameter.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/attributeSets/:attributeSetId/associatedResources", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "attributeSetId", "value": "", "type": "path", "description": "OCID of an attribute set." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "associatedResourceType", "value": "", "type": "query", "description": "A filter to return attribute set associated resources that matches the specified resource type query param." }, { "name": "associatedResourceId", "value": "", "type": "query", "description": "A filter to return attribute set associated resource that matches the specified associated resource id query param." } ] }, "docs": "Returns list of all associated resources." }, { "info": { "name": "Returns the list of audit archive retrieval.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "auditArchiveRetrievalId", "value": "", "type": "query", "description": "OCID of the archive retrieval." }, { "name": "targetId", "value": "", "type": "query", "description": "The OCID of the target associated with the archive retrieval." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that matches the specified lifecycle state." }, { "name": "timeOfExpiry", "value": "", "type": "query", "description": "The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Returns the list of audit archive retrieval.\n" }, { "info": { "name": "Creates a work request to retrieve archived audit data.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a work request to retrieve archived audit data. This asynchronous process will usually take over an hour to complete.\nSave the id from the response of this operation. Call GetAuditArchiveRetrieval operation after an hour, passing the id to know the status of\nthis operation.\n" }, { "info": { "name": "Gets the details of the specified archive retreival.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals/:auditArchiveRetrievalId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditArchiveRetrievalId", "value": "", "type": "path", "description": "OCID of the archive retrieval." } ] }, "docs": "Gets the details of the specified archive retreival." }, { "info": { "name": "Updates the audit archive retrieval.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals/:auditArchiveRetrievalId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditArchiveRetrievalId", "value": "", "type": "path", "description": "OCID of the archive retrieval." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the audit archive retrieval." }, { "info": { "name": "Submits a work request to unload retrieved archive data.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals/:auditArchiveRetrievalId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditArchiveRetrievalId", "value": "", "type": "path", "description": "OCID of the archive retrieval." } ] }, "docs": "To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first.\nThis will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.\n" }, { "info": { "name": "Moves the archive retreival to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditArchiveRetrievals/:auditArchiveRetrievalId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditArchiveRetrievalId", "value": "", "type": "path", "description": "OCID of the archive retrieval." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource.\n" }, { "info": { "name": "Gets summary of Data Safe audit events by time trends, target name, user name, client hostname and object type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditEventAnalytics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "limit", "value": "", "type": "query", "description": "For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "It is usually retrieved from a previous \"List\" call. For details about how pagination works,\nsee [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "scimQuery", "value": "", "type": "query", "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:** (auditEventTime ge \"2021-06-04T01:00:26.000Z\") and (eventName eq \"LOGON\")\nThe 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.\nadminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1.\nThese define admin user activity, common user activity, sensitive data activity and data safe activity\n**Example:** (adminUser eq 1)\n" }, { "name": "summaryField", "value": "", "type": "query", "description": "Specifies a subset of summarized fields to be returned in the response." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "queryTimeZone", "value": "", "type": "query", "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.\n" }, { "name": "groupBy", "value": "", "type": "query", "description": "A groupBy can only be used in combination with summaryField parameter.\nA groupBy value has to be a subset of the values mentioned in summaryField parameter.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is ordered based on this query parameter value." } ] }, "docs": "By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify\nit in the `summaryField` query parameter.\n\n**Example:**\n/auditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname\n&summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess\n&summaryField=allRecord&scimQuery=(auditEventTime ge \"2021-06-13T23:49:14\")\n\n/auditEventAnal" }, { "info": { "name": "Gets a list of Data Safe audit Events collected from the target database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditEvents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "It is usually retrieved from a previous \"List\" call. For details about how pagination works,\nsee [List Pagination](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "scimQuery", "value": "", "type": "query", "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:** (auditEventTime ge \"2021-06-04T01:00:26.000Z\") and (eventName eq \"LOGON\")\nThe 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.\nadminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1.\nThese define admin user activity, common user activity, sensitive data activity and data safe activity\n**Example:** (adminUser eq 1)\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is sorted by this query parameter value.\n" } ] }, "docs": "The ListAuditEvents operation returns specified `compartmentId` audit Events only.\nThe list does not include any audit Events associated with the `subcompartments` of the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even o" }, { "info": { "name": "Retrieves a list of all audit policies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the audit policy." }, { "name": "auditPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified id." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions.\n\nThe ListAuditPolicies operation returns only the audit policies in the specified `compartmentId`.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the res" }, { "info": { "name": "Gets a audit policy by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditPolicies/:auditPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditPolicyId", "value": "", "type": "path", "description": "Unique audit policy identifier." } ] }, "docs": "Gets a audit policy by identifier." }, { "info": { "name": "Updates the audit policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/auditPolicies/:auditPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditPolicyId", "value": "", "type": "path", "description": "Unique audit policy identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the audit policy." }, { "info": { "name": "Moves the specified audit policy and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditPolicies/:auditPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditPolicyId", "value": "", "type": "path", "description": "Unique audit policy identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified audit policy and its dependent resources into a different compartment." }, { "info": { "name": "Provision audit policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditPolicies/:auditPolicyId/actions/provision", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditPolicyId", "value": "", "type": "path", "description": "Unique audit policy identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provision audit policy." }, { "info": { "name": "Retrieves the audit policy details from the source target database.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditPolicies/:auditPolicyId/actions/retrieveFromTarget", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditPolicyId", "value": "", "type": "path", "description": "Unique audit policy identifier." } ] }, "docs": "Retrieves the audit policy details from the source target database." }, { "info": { "name": "Summarizes the audit policy information.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditPolicyAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize audit policy aggregation." }, { "name": "auditPolicyCategory", "value": "", "type": "query", "description": "The category to which the audit policy belongs to." }, { "name": "auditPolicyName", "value": "", "type": "query", "description": "In case of seeded policies, it is the policy name defined by Data Safe.\nIn case of custom Policies, it is the policy name that is used to create the policies on the target database.\nIn case of Oracle Pre-seeded policies, it is the default policy name of the same.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the audit policy." } ] }, "docs": "Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation\nhelps understand the overall state of policies provisioned on targets.\nIt is especially useful to create dashboards or to support analytics.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized " }, { "info": { "name": "Summarizes audit profile information.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfileAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter for summarize operation on audit." }, { "name": "targetType", "value": "", "type": "query", "description": "A optional filter to return only resources that belong to the specified audit profile type." } ] }, "docs": "Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles.\nAs an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be i" }, { "info": { "name": "Gets a list of all audit profiles.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "auditProfileId", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified id." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "targetType", "value": "", "type": "query", "description": "A optional filter to return only resources that belong to the specified audit profile type." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified lifecycle state." }, { "name": "isOverrideGlobalRetentionSetting", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified retention configured value." }, { "name": "isPaidUsageEnabled", "value": "", "type": "query", "description": "Indicates if you want to continue audit record collection beyond the free limit\nof one million audit records per month per target database, incurring additional charges.\nThe default value is inherited from the global settings. You can change at the global level\nor at the target level.\n" }, { "name": "auditCollectedVolumeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only items that have count of audit records collected greater than or equal to the specified value." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Gets a list of all audit profiles.\n\nThe ListAuditProfiles operation returns only the audit profiles in the specified `compartmentId`.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have acces" }, { "info": { "name": "Create a new audit profile resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new audit profile resource." }, { "info": { "name": "Get the details of audit profile.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ] }, "docs": "Gets the details of audit profile resource and associated audit trails of the audit profile." }, { "info": { "name": "Updates one or more attributes of the specified audit profile.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified audit profile." }, { "info": { "name": "Deletes the specified audit profile .", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ] }, "docs": "Deletes the specified audit profile.\nThe audit profile delete operation is only supported for audit profiles with target type as TARGET_DATABASE_GROUP.\n" }, { "info": { "name": "Calculates the audit data volume available on target.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/actions/calculateAuditVolumeAvailable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Calculates the audit data collected by data safe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/actions/calculateAuditVolumeCollected", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Calculates the volume of audit events collected by data safe." }, { "info": { "name": "Moves the specified audit profile and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified audit profile and its dependent resources into a different compartment." }, { "info": { "name": "Change the online and offline months .", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/actions/changeRetention", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the online and offline months ." }, { "info": { "name": "Updates the list of audit trails created under audit profile.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/actions/discoverAuditTrails", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." } ] }, "docs": "Updates the list of audit trails created under audit profile.The\noperation can be used to create new audit trails for target database\nwhen they become available for audit collection because of change of database version\nor change of database unified mode or change of data base edition or being deleted previously etc.\n" }, { "info": { "name": "Gets a list of all data points for the audit volume available on target database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/availableAuditVolumes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The OCID of the work request." }, { "name": "trailLocation", "value": "", "type": "query", "description": "The audit trail location." }, { "name": "monthInConsiderationGreaterThan", "value": "", "type": "query", "description": "Specifying `monthInConsiderationGreaterThan` parameter\nwill retrieve all items for which the event month is\ngreater 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" }, { "name": "monthInConsiderationLessThan", "value": "", "type": "query", "description": "Specifying `monthInConsiderationLessThan` parameter\nwill retrieve all items for which the event month is\nless 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" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending.\n" } ] }, "docs": "Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date." }, { "info": { "name": "Gets a list of all collected audit volume data points.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/collectedAuditVolumes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The OCID of the work request." }, { "name": "monthInConsiderationGreaterThan", "value": "", "type": "query", "description": "Specifying `monthInConsiderationGreaterThan` parameter\nwill retrieve all items for which the event month is\ngreater 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" }, { "name": "monthInConsiderationLessThan", "value": "", "type": "query", "description": "Specifying `monthInConsiderationLessThan` parameter\nwill retrieve all items for which the event month is\nless 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" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order(sortOrder). The default order for all fields is ascending.\n" } ] }, "docs": "Gets a list of all collected audit volume data points." }, { "info": { "name": "Gets a list of targets with their audit profiles and retention settings that override the target group setting.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditProfiles/:auditProfileId/targetOverrides", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditProfileId", "value": "", "type": "path", "description": "The OCID of the audit." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Gets a list of all targets whose audit settings override the target group setting." }, { "info": { "name": "Summarizes audit trail information.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditTrailAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter for summarize operation on audit trail." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "queryTimeZone", "value": "", "type": "query", "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.\n" }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." } ] }, "docs": "Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails.\nAs an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or" }, { "info": { "name": "Gets a list of all audit trails.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditTrails", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "auditTrailId", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified id." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified lifecycle state." }, { "name": "status", "value": "", "type": "query", "description": "A optional filter to return only resources that match the specified sub-state of audit trail." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Gets a list of all audit trails.\nThe ListAuditTrails operation returns only the audit trails in the specified `compartmentId`.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to ev" }, { "info": { "name": "Get the details of audit trail.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ] }, "docs": "Gets the details of audit trail." }, { "info": { "name": "Updates one or more attributes of the specified audit trail.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified audit trail." }, { "info": { "name": "Deletes the specified audit trail .", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ] }, "docs": "Deletes the specified audit trail." }, { "info": { "name": "Resumes the specified audit trail once it got stopped.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId/actions/resume", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ] }, "docs": "Resumes the specified audit trail once it got stopped." }, { "info": { "name": "Starts collection of audit records on the specified audit trail.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts collection of audit records on the specified audit trail." }, { "info": { "name": "Stops the specified audit trail.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/auditTrails/:auditTrailId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "auditTrailId", "value": "", "type": "path", "description": "The OCID of the audit trail." } ] }, "docs": "Stops the specified audit trail." }, { "info": { "name": "Gets a list of basic masking formats compatible with the supported data types.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/compatibleFormatsForDataTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of basic masking formats compatible with the supported data types.\nThe data types are grouped into the following categories -\nCharacter - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2\nNumeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE\nDate - Includes DATE and TIMESTAMP\nLOB - Includes BLOB, CLOB, and NCLOB\nAll - Includes all the supported data types\n" }, { "info": { "name": "Gets a list of library masking formats compatible with the existing sensitive types.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/compatibleFormatsForSensitiveTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of library masking formats compatible with the existing sensitive types.\nFor each sensitive type, it returns the assigned default masking format as well as\nthe other library masking formats that have the sensitiveTypeIds attribute containing\nthe OCID of the sensitive type.\n" }, { "info": { "name": "Gets the details of the Data Safe configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/configuration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return the Data Safe configuration for the specified tenancy OCID." } ] }, "docs": "Gets the details of the Data Safe configuration." }, { "info": { "name": "Enables Data Safe in the tenancy and region.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/configuration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables Data Safe in the tenancy and region.\n" }, { "info": { "name": "Modifies Global Settings in Data Safe in the tenancy and region.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/configuration/:compartmentId/actions/modifyGlobalSettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies Global Settings in Data Safe in the tenancy and region.\n" }, { "info": { "name": "Gets a list of Data Safe private endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified VCN OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of Data Safe private endpoints.\n" }, { "info": { "name": "Creates a new Data Safe private endpoint.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Data Safe private endpoint.\n" }, { "info": { "name": "Gets the details of the specified Data Safe private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints/:dataSafePrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSafePrivateEndpointId", "value": "", "type": "path", "description": "The OCID of the private endpoint." } ] }, "docs": "Gets the details of the specified Data Safe private endpoint." }, { "info": { "name": "Updates one or more attributes of the specified Data Safe private endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints/:dataSafePrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSafePrivateEndpointId", "value": "", "type": "path", "description": "The OCID of the private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Data Safe private endpoint." }, { "info": { "name": "Deletes the specified Data Safe private endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints/:dataSafePrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataSafePrivateEndpointId", "value": "", "type": "path", "description": "The OCID of the private endpoint." } ] }, "docs": "Deletes the specified Data Safe private endpoint." }, { "info": { "name": "ChangeDataSafePrivateEndpointCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/dataSafePrivateEndpoints/:dataSafePrivateEndpointId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dataSafePrivateEndpointId", "value": "", "type": "path", "description": "The OCID of the private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Data Safe private endpoint and its dependent resources to the specified compartment." }, { "info": { "name": "Retrieves a list of all database security configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/databaseSecurityConfigs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the database security configuration." }, { "name": "databaseSecurityConfigId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the database security configuration resource." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all database security configurations in Data Safe.\n\nThe ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even o" }, { "info": { "name": "Gets a database security configuration by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/databaseSecurityConfigs/:databaseSecurityConfigId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseSecurityConfigId", "value": "", "type": "path", "description": "The OCID of the database security configuration resource." } ] }, "docs": "Gets a database security configuration by identifier." }, { "info": { "name": "Updates the database security configuration.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/databaseSecurityConfigs/:databaseSecurityConfigId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseSecurityConfigId", "value": "", "type": "path", "description": "The OCID of the database security configuration resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the database security configuration." }, { "info": { "name": "Moves the specified database security configuration and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/databaseSecurityConfigs/:databaseSecurityConfigId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseSecurityConfigId", "value": "", "type": "path", "description": "The OCID of the database security configuration resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified database security configuration and its dependent resources into a different compartment." }, { "info": { "name": "Refreshes the specified database security configuration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/databaseSecurityConfigs/:databaseSecurityConfigId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseSecurityConfigId", "value": "", "type": "path", "description": "The OCID of the database security configuration resource." } ] }, "docs": "Refreshes the specified database security configuration." }, { "info": { "name": "Gets consolidated discovery analytics data based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/discoveryAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "groupBy", "value": "", "type": "query", "description": "Attribute by which the discovery analytics data should be grouped." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "isCommon", "value": "", "type": "query", "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" }, { "name": "sensitiveTypeGroupId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the sensitive type group resource." } ] }, "docs": "Gets consolidated discovery analytics data based on the specified query parameters.\nIf CompartmentIdInSubtreeQueryParam is specified as true, the behaviour\nis equivalent to accessLevel \"ACCESSIBLE\" by default.\n" }, { "info": { "name": "Gets a list of incremental discovery jobs based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/discoveryJobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "discoveryJobId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified discovery job OCID." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending.\nThe default order for displayName is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of incremental discovery jobs based on the specified query parameters." }, { "info": { "name": "Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/discoveryJobs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs incremental data discovery for the specified sensitive data model. It uses the target database associated\nwith the sensitive data model.\nAfter performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults\nto specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results\nand apply them to the sensitive data model.\n" }, { "info": { "name": "Gets the details of the specified discovery job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." } ] }, "docs": "Gets the details of the specified discovery job." }, { "info": { "name": "Deletes the specified discovery job.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." } ] }, "docs": "Deletes the specified discovery job." }, { "info": { "name": "Moves the specified discovery job and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified discovery job and its dependent resources into a different compartment." }, { "info": { "name": "Gets a list of discovery results based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId/results", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." }, { "name": "discoveryType", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified discovery type." }, { "name": "plannedAction", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified planned action." }, { "name": "isResultApplied", "value": "", "type": "query", "description": "A filter to return the discovery result resources based on the value of their isResultApplied attribute." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending.\nThe default order for discoveryType, schemaName, objectName, columnName and plannedAction is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of discovery results based on the specified query parameters." }, { "info": { "name": "Patches one or more discovery results.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId/results", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using\nApplyDiscoveryJobResults to process the results based on this attribute.\n" }, { "info": { "name": "Gets the details of the specified discovery result.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId/results/:resultKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." }, { "name": "resultKey", "value": "", "type": "path", "description": "The unique key that identifies the discovery result." } ] }, "docs": "Gets the details of the specified discovery result." }, { "info": { "name": "Deletes the specified discovery result.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/discoveryJobs/:discoveryJobId/results/:resultKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The OCID of the discovery job." }, { "name": "resultKey", "value": "", "type": "path", "description": "The unique key that identifies the discovery result." } ] }, "docs": "Deletes the specified discovery result." }, { "info": { "name": "Gets a list of library masking formats based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/libraryMaskingFormats", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "libraryMaskingFormatId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified library masking format OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle states." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "libraryMaskingFormatSource", "value": "", "type": "query", "description": "A filter to return the library masking format resources based on the value of their source attribute." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for displayName is ascending. The displayName sort order is case sensitive.\n" } ] }, "docs": "Gets a list of library masking formats based on the specified query parameters.\n" }, { "info": { "name": "Creates a new library masking format.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/libraryMaskingFormats", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new library masking format. A masking format can have one or more\nformat entries. The combined output of all the format entries is used for masking.\nIt provides the flexibility to define a masking format that can generate different\nparts of a data value separately and then combine them to get the final data value\nfor masking. Note that you cannot define masking condition in a library masking format.\n" }, { "info": { "name": "Gets the details of the specified library masking format.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/libraryMaskingFormats/:libraryMaskingFormatId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "libraryMaskingFormatId", "value": "", "type": "path", "description": "The OCID of the library masking format." } ] }, "docs": "Gets the details of the specified library masking format." }, { "info": { "name": "Updates one or more attributes of the specified library masking format.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/libraryMaskingFormats/:libraryMaskingFormatId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "libraryMaskingFormatId", "value": "", "type": "path", "description": "The OCID of the library masking format." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Deletes the specified library masking format.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/libraryMaskingFormats/:libraryMaskingFormatId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "libraryMaskingFormatId", "value": "", "type": "path", "description": "The OCID of the library masking format." } ] }, "docs": "Deletes the specified library masking format." }, { "info": { "name": "Moves the specified library masking format into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/libraryMaskingFormats/:libraryMaskingFormatId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "libraryMaskingFormatId", "value": "", "type": "path", "description": "The OCID of the library masking format." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified library masking format into a different compartment." }, { "info": { "name": "Gets consolidated masking analytics data based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "groupBy", "value": "", "type": "query", "description": "Attribute by which the masking analytics data should be grouped." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "maskingPolicyId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy OCID." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets consolidated masking analytics data based on the specified query parameters.\nIf CompartmentIdInSubtreeQueryParam is specified as true, the behaviour\nis equivalent to accessLevel \"ACCESSIBLE\" by default.\n" }, { "info": { "name": "Gets a list of masking policies based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle states." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for displayName is ascending. The displayName sort order is case sensitive.\n" }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of masking policies based on the specified query parameters." }, { "info": { "name": "Creates a new masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new masking policy and associates it with a sensitive data model or a target database.\n\nTo use a sensitive data model as the source of masking columns, set the columnSource attribute to\nSENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy,\nyou can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from\nthe associated sensitive data model. In this case, the target database associated with the\nsensitive data mod" }, { "info": { "name": "Gets the details of the specified masking policy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ] }, "docs": "Gets the details of the specified masking policy." }, { "info": { "name": "Updates one or more attributes of the specified masking policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified masking policy." }, { "info": { "name": "Deletes the specified masking policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ] }, "docs": "Deletes the specified masking policy." }, { "info": { "name": "Adds columns to the specified masking policy from the associated sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/addMaskingColumnsFromSdm", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ] }, "docs": "Adds columns to the specified masking policy from the associated sensitive data model. It\nautomatically pulls all the sensitive columns and their relationships from the sensitive\ndata model and uses this information to create columns in the masking policy. It also assigns\ndefault masking formats to these columns based on the associated sensitive types.\n" }, { "info": { "name": "Moves the specified masking policy and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified masking policy and its dependent resources into a different compartment." }, { "info": { "name": "Downloads an already-generated file corresponding to the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/download", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads an already-generated file corresponding to the specified masking policy.\nNote that the GenerateMaskingPolicyForDownload operation is a prerequisite for the\nDownloadMaskingPolicy operation. Use GenerateMaskingPolicyForDownload to generate\na masking policy file and then use DownloadMaskingPolicy to download the generated file.\n" }, { "info": { "name": "Downloads masking log.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/downloadLog", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads the masking log generated by the last masking operation on a target database using the specified masking policy." }, { "info": { "name": "Downloads an already-generated masking report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/downloadReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads an already-generated masking report. Note that the GenerateMaskingReportForDownload\noperation is a prerequisite for the DownloadMaskingReport operation. Use GenerateMaskingReportForDownload\nto generate a masking report file and then use DownloadMaskingReport to download the generated file.\n" }, { "info": { "name": "Performs health check.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/generateHealthReport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs health check on the masking policy." }, { "info": { "name": "Generates a downloadable file corresponding to the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/generatePolicyForDownload", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a downloadable file corresponding to the specified masking policy. It's\na prerequisite for the DownloadMaskingPolicy operation. Use this endpoint to generate\na masking policy file and then use DownloadMaskingPolicy to download the generated file.\nNote that file generation and download are serial operations. The download operation\ncan't be invoked while the generate operation is in progress.\n" }, { "info": { "name": "Generates a downloadable masking report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/generateReportForDownload", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a downloadable masking report. It's a prerequisite for the\nDownloadMaskingReport operation. Use this endpoint to generate a\nmasking report file and then use DownloadMaskingReport to download\nthe generated file.\n" }, { "info": { "name": "Masks data using the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/mask", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Masks data using the specified masking policy." }, { "info": { "name": "Uploads a masking policy file to update the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/actions/upload", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a masking policy file (also called template) to update the specified masking policy.\nTo create a new masking policy using a file, first use the CreateMaskingPolicy operation\nto create an empty masking policy and then use this endpoint to upload the masking policy file.\nNote that the upload operation replaces the content of the specified masking policy,\nincluding all the existing columns and masking formats, with the content of the file.\n" }, { "info": { "name": "Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for other fields is ascending.\n" }, { "name": "maskingColumnLifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle states." }, { "name": "dataType", "value": "", "type": "query", "description": "A filter to return only resources that match the specified data types." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "objectType", "value": "", "type": "query", "description": "A filter to return only items related to a specific object type." }, { "name": "maskingColumnGroup", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking column group." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "isMaskingEnabled", "value": "", "type": "query", "description": "A filter to return the masking column resources based on the value of their isMaskingEnabled attribute.\nA value of true returns only those columns for which masking is enabled. A value of false returns only those columns\nfor which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.\n" }, { "name": "isSeedRequired", "value": "", "type": "query", "description": "A filter to return masking columns based on whether the assigned masking formats need a\nseed value for masking. A value of true returns those masking columns that are using\nDeterministic Encryption or Deterministic Substitution masking format.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUpdatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Search for resources that were updated after a specific date.\nSpecifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo`\nparameter will retrieve all resources updated after the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" }, { "name": "timeUpdatedLessThan", "value": "", "type": "query", "description": "Search for resources that were updated before a specific date.\nSpecifying this parameter corresponding `timeUpdatedLessThan`\nparameter will retrieve all resources updated before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" } ] }, "docs": "Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.\n" }, { "info": { "name": "Creates a new masking column in the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new masking column in the specified masking policy. Use this operation\nto add parent columns only. It automatically adds the child columns from the\nassociated sensitive data model or target database. If you provide the\nsensitiveTypeId attribute but not the maskingFormats attribute, it automatically\nassigns the default masking format associated with the specified sensitive type.\nAlternatively, if you provide the maskingFormats attribute, the specified masking\nformats are assigned to the" }, { "info": { "name": "Patches one or more columns in the specified masking policy.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more columns in the specified masking policy. Use it to create, or update\nmasking columns. To create masking columns, use CreateMaskingColumnDetails as the patch\nvalue. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.\n" }, { "info": { "name": "Applies the difference of a SDM Masking policy difference resource to the specified masking policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns/actions/applyDifferenceToMaskingColumns", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies the difference of a SDM Masking policy difference resource to the specified masking policy. Note that the plannedAction attribute\nof difference columns is used for processing. You should first use PatchSdmMaskingPolicyDifferenceColumns to set the plannedAction\nattribute of the difference columns you want to process. ApplySdmMaskingPolicyDifference automatically reads the plannedAction\nattribute and updates the masking policy to reflect the actions you planned. If the sdmMaskingPolicydiff" }, { "info": { "name": "Gets the details of the specified masking column.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns/:maskingColumnKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." }, { "name": "maskingColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the masking column. It's numeric and unique within a masking policy." } ] }, "docs": "Gets the details of the specified masking column." }, { "info": { "name": "Updates one or more attributes of the specified masking column.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns/:maskingColumnKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the masking column. It's numeric and unique within a masking policy." }, { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified masking column. Note that updating the maskingFormats\nattribute replaces the currently assigned masking formats with the specified masking formats.\n" }, { "info": { "name": "Deletes the specified masking column.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingColumns/:maskingColumnKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the masking column. It's numeric and unique within a masking policy." }, { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." } ] }, "docs": "Deletes the specified masking column." }, { "info": { "name": "Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "objectType", "value": "", "type": "query", "description": "A filter to return only items related to a specific object type." } ] }, "docs": "Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/maskingSchemas", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." } ] }, "docs": "Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of referential relations present in the specified masking policy based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicies/:maskingPolicyId/referentialRelations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyId", "value": "", "type": "path", "description": "The OCID of the masking policy." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "relationType", "value": "", "type": "query", "description": "A filter to return columns based on their relationship with their parent columns. If set to NONE,\nit returns the columns that do not have any parent. The response includes the parent columns as\nwell as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the\nchild columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED,\nit returns all the child columns that have database-level (dictionary-defined) relationship with their parents.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder).\n" } ] }, "docs": "Gets a list of referential relations present in the specified masking policy based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of masking policy health reports based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicyHealthReports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyHealthReportId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy health report OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "maskingPolicyId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle states." } ] }, "docs": "Gets a list of masking policy health reports based on the specified query parameters." }, { "info": { "name": "Gets the details of the specified masking policy health report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicyHealthReports/:maskingPolicyHealthReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyHealthReportId", "value": "", "type": "path", "description": "The OCID of the masking health report." } ] }, "docs": "Gets the details of the specified masking policy health report." }, { "info": { "name": "Deletes the specified masking policy health report.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/maskingPolicyHealthReports/:maskingPolicyHealthReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyHealthReportId", "value": "", "type": "path", "description": "The OCID of the masking health report." } ] }, "docs": "Deletes the specified masking policy health report." }, { "info": { "name": "Moves the specified masking policy health report and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/maskingPolicyHealthReports/:maskingPolicyHealthReportId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyHealthReportId", "value": "", "type": "path", "description": "The OCID of the masking health report." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified masking policy health report and its dependent resources into a different compartment." }, { "info": { "name": "Gets a list of errors and warnings from a masking policy health check.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingPolicyHealthReports/:maskingPolicyHealthReportId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingPolicyHealthReportId", "value": "", "type": "path", "description": "The OCID of the masking health report." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "sort by" }, { "name": "messageType", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified log message type." } ] }, "docs": "Gets a list of errors and warnings from a masking policy health check.\n" }, { "info": { "name": "Gets a list of masking reports based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingReports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "maskingPolicyId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy OCID." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeMaskingFinished is descending.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of masking reports based on the specified query parameters." }, { "info": { "name": "Gets the details of the specified masking report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingReports/:maskingReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingReportId", "value": "", "type": "path", "description": "The OCID of the masking report." } ] }, "docs": "Gets the details of the specified masking report." }, { "info": { "name": "Deletes the specified masking report.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/maskingReports/:maskingReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingReportId", "value": "", "type": "path", "description": "The OCID of the masking report." } ] }, "docs": "Deletes the specified masking report." }, { "info": { "name": "Gets a list of masked columns present in the specified masking report and based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingReports/:maskingReportId/maskedColumns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingReportId", "value": "", "type": "path", "description": "The OCID of the masking report." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for all the fields is ascending.\n" }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "objectType", "value": "", "type": "query", "description": "A filter to return only items related to a specific object type." }, { "name": "maskingColumnGroup", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking column group." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." } ] }, "docs": "Gets a list of masked columns present in the specified masking report and based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of masking errors in a masking run based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/maskingReports/:maskingReportId/maskingErrors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maskingReportId", "value": "", "type": "path", "description": "The OCID of the masking report." }, { "name": "stepName", "value": "", "type": "query", "description": "A filter to return only masking errors that match the specified step name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. The default order will be ascending." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Gets a list of masking errors in a masking run based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of on-premises connectors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/onPremConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "onPremConnectorId", "value": "", "type": "query", "description": "A filter to return only the on-premises connector that matches the specified id." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only on-premises connector resources that match the specified lifecycle state." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of on-premises connectors.\n" }, { "info": { "name": "Creates a new on-premises connector.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/onPremConnectors", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new on-premises connector.\n" }, { "info": { "name": "Gets the details of the specified on-premises connector.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ] }, "docs": "Gets the details of the specified on-premises connector." }, { "info": { "name": "Updates one or more attributes of the specified on-premises connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified on-premises connector." }, { "info": { "name": "Deletes the specified on-premises connector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ] }, "docs": "Deletes the specified on-premises connector." }, { "info": { "name": "Moves the specified on-premises connector into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified on-premises connector into a different compartment." }, { "info": { "name": "Creates and downloads the configuration of the specified on-premises connector.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId/actions/generateConfiguration", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and downloads the configuration of the specified on-premises connector.\n" }, { "info": { "name": "Updates the wallet of the specified on-premises connector to a new version.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/onPremConnectors/:onPremConnectorId/wallet", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onPremConnectorId", "value": "", "type": "path", "description": "The OCID of the on-premises connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the wallet for the specified on-premises connector to a new version.\n" }, { "info": { "name": "Retrieves the list of Registration Policies according to the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/registrationPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field to sort the registration policies by. Only one sort order (sortOrder) can be specified. Defaults to sorting by `timeCreated` in descending order\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter registration policies by their lifecycle state." }, { "name": "enablementLevel", "value": "", "type": "query", "description": "Filter registration policies by resource type." }, { "name": "resourceId", "value": "", "type": "query", "description": "Filter to return the registration policy matching the specified resource OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "registrationPolicyId", "value": "", "type": "query", "description": "Filter to return the registration policy matching the specified OCID." }, { "name": "connectionType", "value": "", "type": "query", "description": "Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT." }, { "name": "connectionId", "value": "", "type": "query", "description": "Filter to return the registration policies matching the specified connection ID." } ] }, "docs": "Retrieves a list of registration policies according to the specified query parameters.\n" }, { "info": { "name": "Creates a new OptIn/Registration Policy", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/registrationPolicies", "headers": [ { "name": "opc-dry-run", "value": "" }, { "name": "x-cluster-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OptIn/Registration Policy" }, { "info": { "name": "Returns the details of the specified Registration Policy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/registrationPolicies/:registrationPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "registrationPolicyId", "value": "", "type": "path", "description": "The OCID of the registration policy to be used for identification" } ] }, "docs": "Returns the details of the specified Registration Policy.\n" }, { "info": { "name": "Updates one or more attributes of the specified registration policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/registrationPolicies/:registrationPolicyId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "registrationPolicyId", "value": "", "type": "path", "description": "The OCID of the registration policy to be used for identification" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified registration policy." }, { "info": { "name": "Deletes the specified registration policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/registrationPolicies/:registrationPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "registrationPolicyId", "value": "", "type": "path", "description": "The OCID of the registration policy to be used for identification" } ] }, "docs": "Deletes the specified registration policy." }, { "info": { "name": "Moves the registration policy to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/registrationPolicies/:registrationPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "registrationPolicyId", "value": "", "type": "path", "description": "The OCID of the registration policy to be used for identification" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the registration policy to the specified compartment." }, { "info": { "name": "Gets a list of report definitions. The report definitions can be seeded or user created.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/reportDefinitions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The name of the report definition to query." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting parameter order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "isSeeded", "value": "", "type": "query", "description": "A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions." }, { "name": "dataSource", "value": "", "type": "query", "description": "Specifies the name of a resource that provides data for the report. For example alerts, events." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified lifecycle state." }, { "name": "category", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified category." } ] }, "docs": "Gets a list of report definitions.\nThe ListReportDefinitions operation returns only the report definitions in the specified `compartmentId`.\nIt also returns the seeded report definitions which are available to all the compartments.\n" }, { "info": { "name": "Creates a new report definition", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reportDefinitions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.\n" }, { "info": { "name": "Gets details of the specified report definition", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ] }, "docs": "Gets the details of report definition specified by the identifier" }, { "info": { "name": "Updates the specified report definition.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Deletes the specified report definition", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ] }, "docs": "Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Generates a .xls or .pdf report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId/actions/generateReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(auditEventTime ge \"2021-06-04T01:00:26.000Z\") and (eventName eq \"LOGON\")\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a .xls or .pdf report based on parameters and report definition." }, { "info": { "name": "Deletes schedule of a .xls or .pdf report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId/actions/removeScheduleReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ] }, "docs": "Deletes the schedule of a .xls or .pdf report." }, { "info": { "name": "Schedules a .xls or .pdf report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reportDefinitions/:reportDefinitionId/actions/scheduleReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportDefinitionId", "value": "", "type": "path", "description": "Unique report definition identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules a .xls or .pdf report based on parameters and report definition." }, { "info": { "name": "Gets a list of all the reports in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/reports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The name of the report definition to query." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "mimeType", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified mime type." }, { "name": "reportDefinitionId", "value": "", "type": "query", "description": "The ID of the report definition to filter the list of reports" }, { "name": "timeGeneratedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeGeneratedLessThan", "value": "", "type": "query", "description": "Search for resources that were generated before a specific date.\nSpecifying this parameter corresponding `timeGeneratedLessThan`\nparameter will retrieve all resources generated before the\nspecified generated date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified lifecycle state." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified type." }, { "name": "dataSource", "value": "", "type": "query", "description": "Specifies the name of a resource that provides data for the report. For example alerts, events." } ] }, "docs": "Gets a list of all the reports in the compartment. It contains information such as report generation time." }, { "info": { "name": "Gets the details of the specified report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/reports/:reportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique report identifier" } ] }, "docs": "Gets a report by identifier" }, { "info": { "name": "Updates the specified report.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/reports/:reportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique report identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified report. Only tags can be updated." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/reports/:reportId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique report identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Download the specified report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/reports/:reportId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "reportId", "value": "", "type": "path", "description": "Unique report identifier" } ] }, "docs": "Downloads the specified report in the form of .xls or .pdf." }, { "info": { "name": "Gets a list of SDM and masking policy difference resources based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "differenceAccessLevel", "value": "", "type": "query", "description": "Valid value is ACCESSIBLE. Default is ACCESSIBLE.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle states." }, { "name": "maskingPolicyId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified masking policy OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreationStarted is descending.\nThe default order for displayName is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of SDM and masking policy difference resources based on the specified query parameters." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates SDM masking policy difference for the specified masking policy. It finds the difference between\nmasking columns of the masking policy and sensitive columns of the SDM. After performing this operation,\nyou can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns\nto specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the\ndifference columns and apply them to the masking policy.\n" }, { "info": { "name": "Gets the details of the specified SDM Masking policy difference.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." } ] }, "docs": "Gets the details of the specified SDM Masking policy difference." }, { "info": { "name": "Updates one or more attributes of the specified sdm masking policy difference.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sdm masking policy difference." }, { "info": { "name": "Deletes the specified SDM Masking policy difference.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." } ] }, "docs": "Deletes the specified SDM Masking policy difference." }, { "info": { "name": "Moves the specified SDM masking policy difference into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified SDM masking policy difference into a different compartment." }, { "info": { "name": "Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId/differenceColumns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." }, { "name": "differenceType", "value": "", "type": "query", "description": "A filter to return only the SDM masking policy difference columns that match the specified difference type" }, { "name": "plannedAction", "value": "", "type": "query", "description": "A filter to return only the SDM masking policy difference columns that match the specified planned action." }, { "name": "syncStatus", "value": "", "type": "query", "description": "A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for schemaName is descending.\nThe default order for differenceType, schemaName, objectName, columnName and plannedAction is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters." }, { "info": { "name": "Patches one or more SDM masking policy difference columns.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId/differenceColumns", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using\nApplySdmMaskingPolicyDifference to process the difference based on this attribute.\n" }, { "info": { "name": "Gets the details of the specified SDM Masking policy difference column.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sdmMaskingPolicyDifferences/:sdmMaskingPolicyDifferenceId/differenceColumns/:differenceColumnKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdmMaskingPolicyDifferenceId", "value": "", "type": "path", "description": "The OCID of the SDM masking policy difference." }, { "name": "differenceColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the difference column." } ] }, "docs": "Gets the details of the specified SDM Masking policy difference column." }, { "info": { "name": "Gets a list of security assessments. Security assessments can be of type: LATEST, SAVED, SAVE_SCHEDULE, TEMPLATE, TEMPLATE_BASELINE or COMPARTMENT.\nWhen using COMPARTMENT type, the list of all security assessments across all compartments will be returned.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only items that match the specified security assessment type." }, { "name": "scheduleAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type SAVE_SCHEDULE." }, { "name": "isScheduleAssessment", "value": "", "type": "query", "description": "A filter to return only security assessments of type save schedule.\n" }, { "name": "triggeredBy", "value": "", "type": "query", "description": "A filter to return only security assessments that were created by either user or system." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "isBaseline", "value": "", "type": "query", "description": "A filter to return only the security assessments that are set as a baseline." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order(sortOrder). The default order for timeCreated is descending.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "targetType", "value": "", "type": "query", "description": "A filter to return only only target database resources or target database group resources." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "templateAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type TEMPLATE." } ] }, "docs": "Gets a list of security assessments.\n\nThe ListSecurityAssessments operation returns only the assessments in the specified `compartmentId`.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have " }, { "info": { "name": "Creates a new saved security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new saved security assessment for a target database or target database group in a compartment. When this operation is performed,\nit will save the latest assessment in the specified compartment. If a schedule is passed, it will persist the latest assessment,\nat the defined date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "info": { "name": "Gets a list of findings aggregated details in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/findingAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "isTopFinding", "value": "", "type": "query", "description": "A filter to return only the findings that are marked as top findings." }, { "name": "groupBy", "value": "", "type": "query", "description": "Attribute by which the finding analytics data should be grouped." }, { "name": "topFindingStatus", "value": "", "type": "query", "description": "An optional filter to return only the top finding that match the specified status." }, { "name": "severity", "value": "", "type": "query", "description": "A filter to return only findings of a particular risk level." }, { "name": "findingKey", "value": "", "type": "query", "description": "The unique key that identifies the finding. It is a string and unique within a security assessment." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "containsReferences", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references." }, { "name": "targetIds", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids." }, { "name": "category", "value": "", "type": "query", "description": "The category of the finding." }, { "name": "containsSeverity", "value": "", "type": "query", "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." }, { "name": "scimQuery", "value": "", "type": "query", "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:** |\nscimQuery=(severity eq 'high')\nscimQuery=(category eq \"Users\") and (reference eq 'CIS')\n\nSupported fields:\nseverity\nreference\ntitle\ncategory\n" } ] }, "docs": "Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state\nof security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey,\nand as well as get the list of the targets that match the condition.\nThis data is especially useful content for the statistic chart or to support analytics.\n\nWhen you perform the ListFindingAnalytics operation, if the parameter compartme" }, { "info": { "name": "Gets a list of Database security feature usage aggregated details in the specific compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/securityFeatureAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." } ] }, "docs": "Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the\noverall security controls, by returning the counting number of the target databases using the security features.\n\nWhen you perform the ListSecurityFeatureAnalytics 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 request" }, { "info": { "name": "Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/securityFeatures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetsWithUnifiedAudit", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Unified Audit enabled/disabled." }, { "name": "targetsWithFineGrainedAudit", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Fine Grained Audit enabled/disabled." }, { "name": "targetsWithTraditionalAudit", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Traditional Audit enabled/disabled." }, { "name": "targetsWithDatabaseVault", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Database Vault enabled/disabled." }, { "name": "targetsWithPrivilegeAnalysis", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Privilege Analysis enabled/disabled." }, { "name": "targetsWithTablespaceEncryption", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Tablespace Encryption enabled/disabled." }, { "name": "targetsWithColumnEncryption", "value": "", "type": "query", "description": "A filter to return only the targets that enable the DB security feature - Column Encryption enabled/disabled." }, { "name": "targetsWithNetworkEncryption", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Network Encryption enabled/disabled." }, { "name": "targetsWithPasswordAuthentication", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Password Authentication enabled/disabled." }, { "name": "targetsWithGlobalAuthentication", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - Global Authentication enabled/disabled." }, { "name": "targetsWithExternalAuthentication", "value": "", "type": "query", "description": "A filter to return only the targets with the DB security feature - External Authentication enabled/disabled." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." } ] }, "docs": "Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.\n" }, { "info": { "name": "Gets a list of template aggregated details in the specific compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/templateAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "templateAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type TEMPLATE." }, { "name": "templateBaselineAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type TEMPLATE_BASELINE." }, { "name": "isGroup", "value": "", "type": "query", "description": "A filter to return only the target group related information if the OCID belongs to a target group." }, { "name": "isCompared", "value": "", "type": "query", "description": "A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done." }, { "name": "isCompliant", "value": "", "type": "query", "description": "A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of template aggregated 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. It also provides information\nabout the statistics for the template baseline and the comparison related. If the comparison is done, it will show if there is any drift,\nand how many checks have drifts.\nThe dimension field - isGroup identifies if the targetId belongs to a target group or" }, { "info": { "name": "Gets a list of template association details in the specific compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/templateAssociationAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "templateAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type TEMPLATE." }, { "name": "templateBaselineAssessmentId", "value": "", "type": "query", "description": "The OCID of the security assessment of type TEMPLATE_BASELINE." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "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 fie" }, { "info": { "name": "Gets the details of the specified security assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ] }, "docs": "Gets the details of the specified security assessment." }, { "info": { "name": "Updates one or more attributes of the specified security assessment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.\n" }, { "info": { "name": "Deletes the specified security assessment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ] }, "docs": "Deletes the specified saved security assessment or schedule. To delete a security assessment schedule,\nfirst call the operation ListSecurityAssessments with filters \"type = save_schedule\".\nThat operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId.\nIf the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.\n" }, { "info": { "name": "Apply the checks from the template to the specified security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/applyTemplate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'." }, { "info": { "name": "Moves the specified saved security assessment or future scheduled assessments into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified saved security assessment or future scheduled assessments into a different compartment.\n\nTo start, call first the operation ListSecurityAssessments with filters \"type = save_schedule\". This returns the scheduleAssessmentId. Then, call this changeCompartment with the scheduleAssessmentId.\n\nThe existing saved security assessments created due to the schedule are not moved. However, all new saves will be associated with the new compartment.\n" }, { "info": { "name": "Compares security assessments.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/compare", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Compares two security assessments. For this comparison, a security assessment can be a saved assessment, a latest assessment, or a baseline assessment.\nFor example, you can compare saved assessment or a latest assessment against a baseline.\n" }, { "info": { "name": "Compares latest target-group security assessment to template-baseline security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/compareToTemplateBaseline", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Compares two security assessments. For this comparison, the security assessment in the path needs to be a latest assessment of a target group.\n" }, { "info": { "name": "Downloads the report of the specified security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/downloadReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads the report of the specified security assessment. To download the security assessment report, it needs to be generated first.\nPlease use GenerateSecurityAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).\n" }, { "info": { "name": "Generates the report of the specified security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/generateReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates the report of the specified security assessment. You can get the report in PDF or XLS format.\nAfter generating the report, use DownloadSecurityAssessmentReport to download it in the preferred format.\n" }, { "info": { "name": "Runs a security assessment, updates the latest assessment, and saves it for future reference.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/refresh", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Runs a security assessment, refreshes the latest assessment, and saves it for future reference.\nThe 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.\n" }, { "info": { "name": "Remove the checks from the template to the specified security assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/removeTemplate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ] }, "docs": "Remove the checks from the template to the specified security assessment.The security assessment provided in the path needs to be of type 'LATEST'." }, { "info": { "name": "Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/setBaseline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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'." }, { "info": { "name": "Removes the baseline setting for the saved security assessment. The saved security assessment is no longer considered a baseline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/actions/unsetBaseline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the baseline setting for the saved security assessment associated with the targetId passed via body.\nIf 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.\nSets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.\n" }, { "info": { "name": "Lists all the security checks in the specified compartment for security assessment of type TEMPLATE.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/checks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order(sortOrder). The default order for title is ascending.\n" }, { "name": "suggestedSeverity", "value": "", "type": "query", "description": "A filter to return only checks of a particular risk level." }, { "name": "containsSeverity", "value": "", "type": "query", "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." }, { "name": "containsReferences", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "key", "value": "", "type": "query", "description": "Each check in security assessment has an associated key (think of key as a check's name).\nFor a given check, the key will be the same across targets. The user can use these keys to filter the checks.\n" } ] }, "docs": "Lists all the security checks in the specified compartment for security assessment of type TEMPLATE.\n" }, { "info": { "name": "Patches one or more checks in the specified security assessment.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/checks", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more checks in the specified template type security assessment. Use it to add or delete checks.\nTo add check, use CreateCheckDetails as the patch value.\n" }, { "info": { "name": "Gets the details of the comparison report for the provided security assessments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/comparison/:comparisonSecurityAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "comparisonSecurityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment baseline." } ] }, "docs": "Gets the details of the comparison report for the security assessments submitted for comparison." }, { "info": { "name": "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.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/findings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "isTopFinding", "value": "", "type": "query", "description": "A filter to return only the findings that are marked as top findings." }, { "name": "severity", "value": "", "type": "query", "description": "A filter to return only findings of a particular risk level." }, { "name": "containsSeverity", "value": "", "type": "query", "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." }, { "name": "category", "value": "", "type": "query", "description": "The category of the finding." }, { "name": "containsOracleDefinedSeverity", "value": "", "type": "query", "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." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the findings that match the specified lifecycle states." }, { "name": "references", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified reference." }, { "name": "containsReferences", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetIds", "value": "", "type": "query", "description": "An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "findingKey", "value": "", "type": "query", "description": "Each finding in security assessment has an associated key (think of key as a finding's name).\nFor a given finding, the key will be the same across targets. The user can use these keys to filter the findings.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "Patches one or more findings in the specified security assessment.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/findings", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more findings in the specified template baseline type security assessment. Use it to modify max allowed risk level in template baseline.\n" }, { "info": { "name": "Updates one or more attributes of the specified finding.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/findings/:findingKey", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "findingKey", "value": "", "type": "path", "description": "The unique key that identifies the finding. It is a string and unique within a security assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified finding." }, { "info": { "name": "List all risk level changes made by user for findings for the specified assessment.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/findingsChangeAuditLogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "severity", "value": "", "type": "query", "description": "A filter to return only findings of a particular risk level." }, { "name": "findingKey", "value": "", "type": "query", "description": "The unique key that identifies the finding. It is a string and unique within a security assessment." }, { "name": "findingTitle", "value": "", "type": "query", "description": "The unique title that identifies the finding. It is a string and unique within a security assessment." }, { "name": "isRiskDeferred", "value": "", "type": "query", "description": "A filter to check findings whose risks were deferred by the user." }, { "name": "modifiedBy", "value": "", "type": "query", "description": "A filter to check which user modified the risk level of the finding." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order(sortOrder). The default order for timeUpdated is descending.\n" }, { "name": "timeValidUntilGreaterThanOrEqualTo", "value": "", "type": "query", "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" }, { "name": "timeValidUntilLessThan", "value": "", "type": "query", "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" }, { "name": "timeUpdatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Search for resources that were updated after a specific date.\nSpecifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo`\nparameter will retrieve all resources updated after the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" }, { "name": "timeUpdatedLessThan", "value": "", "type": "query", "description": "Search for resources that were updated before a specific date.\nSpecifying this parameter corresponding `timeUpdatedLessThan`\nparameter will retrieve all resources updated before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" } ] }, "docs": "List all changes made by user to risk level of findings of the specified assessment.\n" }, { "info": { "name": "Gets the details of the comparison report for the provided security assessments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityAssessments/:securityAssessmentId/templateBaselineComparison/:comparisonSecurityAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment." }, { "name": "comparisonSecurityAssessmentId", "value": "", "type": "path", "description": "The OCID of the security assessment baseline." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "category", "value": "", "type": "query", "description": "The category of the finding." }, { "name": "findingKey", "value": "", "type": "query", "description": "The unique key that identifies the finding. It is a string and unique within a security assessment." } ] }, "docs": "Gets the details of the comparison report for the security assessments submitted for comparison." }, { "info": { "name": "Retrieves a list of all security policies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the security policy." }, { "name": "securityPolicyType", "value": "", "type": "query", "description": "The type of the security policy." }, { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all security policies in Data Safe.\n\nThe ListSecurityPolicies operation returns only the security policies in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is" }, { "info": { "name": "Creates a security policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Data Safe security policy.\n" }, { "info": { "name": "Gets a security policy by the specified OCID of the security policy resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicies/:securityPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "path", "description": "The OCID of the security policy resource." } ] }, "docs": "Gets a security policy by the specified OCID of the security policy resource." }, { "info": { "name": "Updates the security policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/securityPolicies/:securityPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "path", "description": "The OCID of the security policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the security policy." }, { "info": { "name": "Deletes the specified security policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/securityPolicies/:securityPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "path", "description": "The OCID of the security policy resource." } ] }, "docs": "Deletes the specified security policy." }, { "info": { "name": "Moves the specified security policy and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicies/:securityPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "path", "description": "The OCID of the security policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified security policy and its dependent resources into a different compartment." }, { "info": { "name": "Retrieves a list of all security policy configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyConfigs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyConfigId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy configuration resource." }, { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the security policy configuration resource." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all security policy configurations in Data Safe.\n\nThe ListSecurityPolicyConfigs operation returns only the security policy configurations in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of " }, { "info": { "name": "Creates a new security policy configuration resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyConfigs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new security policy configuration resource.\n" }, { "info": { "name": "Gets a security policy configuration by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyConfigs/:securityPolicyConfigId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyConfigId", "value": "", "type": "path", "description": "The OCID of the security policy configuration resource." } ] }, "docs": "Gets a security policy configuration by identifier." }, { "info": { "name": "Updates the security policy configuration.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/securityPolicyConfigs/:securityPolicyConfigId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyConfigId", "value": "", "type": "path", "description": "The OCID of the security policy configuration resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the security policy configuration." }, { "info": { "name": "Deletes the specified Security policy configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/securityPolicyConfigs/:securityPolicyConfigId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyConfigId", "value": "", "type": "path", "description": "The OCID of the security policy configuration resource." } ] }, "docs": "Deletes the specified Security policy configuration." }, { "info": { "name": "Moves the specified security policy configuration and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyConfigs/:securityPolicyConfigId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityPolicyConfigId", "value": "", "type": "path", "description": "The OCID of the security policy configuration resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified security policy configuration and its dependent resources into a different compartment." }, { "info": { "name": "Retrieves a list of all security policy deployments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyDeployments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the security policy deployment." }, { "name": "securityPolicyDeploymentId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy deployment resource." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetType", "value": "", "type": "query", "description": "A optional filter to return only resources that belong to the specified target type." }, { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all security policy deployments in Data Safe.\n\nThe ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of th" }, { "info": { "name": "Creates a security policy deployment in the Data Safe Console.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyDeployments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Data Safe security policy deployment in the Data Safe Console.\n" }, { "info": { "name": "Gets a security policy deployment by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ] }, "docs": "Gets a security policy deployment by identifier." }, { "info": { "name": "Updates the security policy deployment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the security policy deployment." }, { "info": { "name": "Deletes the specified Security policy deployment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ] }, "docs": "Deletes the specified Security policy deployment." }, { "info": { "name": "Moves the specified security policy deployment and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified security policy deployment and its dependent resources into a different compartment." }, { "info": { "name": "Deploy the security policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId/actions/deploy", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ] }, "docs": "Deploy the security policy to the specified target or target groups." }, { "info": { "name": "Refresh the security policy deployment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." } ] }, "docs": "Retrieve all the security policies from the associated target or target group and refresh the same on Data safe." }, { "info": { "name": "Retrieves a list of all security policy entry states.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId/securityPolicyEntryStates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "deploymentStatus", "value": "", "type": "query", "description": "The current state of the security policy deployment." }, { "name": "securityPolicyEntryId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified security policy entry OCID." }, { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." }, { "name": "securityPolicyEntryType", "value": "", "type": "query", "description": "The type of the security policy deployment." }, { "name": "targetId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified target id." } ] }, "docs": "Retrieves a list of all security policy entry states in Data Safe.\n\nThe ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.\n" }, { "info": { "name": "Gets a security policy entity states by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyDeployments/:securityPolicyDeploymentId/securityPolicyEntryStates/:securityPolicyEntryStateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyDeploymentId", "value": "", "type": "path", "description": "The OCID of the security policy deployment resource." }, { "name": "securityPolicyEntryStateId", "value": "", "type": "path", "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" } ] }, "docs": "Gets a security policy entity states by identifier." }, { "info": { "name": "Retrieves a list of all security policy reports.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the security policy report." }, { "name": "securityPolicyReportId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy report resource." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all security policy reports in Data Safe.\n\nThe ListSecurityPolicyReports operation returns only the security policy reports in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child comp" }, { "info": { "name": "Gets a security policy report by the specified OCID of the security policy report resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." } ] }, "docs": "Gets a security policy report by the specified OCID of the security policy report resource." }, { "info": { "name": "Retrieves a list of all database table access entries.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId/databaseTableAccessEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(accessType eq \"SELECT\") and (grantee eq \"ADMIN\")\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter should be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Retrieves a list of all database table access entries in Data Safe.\n\nThe ListDatabaseTableAccessEntries operation returns only the database table access reports for the specified security policy report.\n" }, { "info": { "name": "Gets a database table access entry object by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId/databaseTableAccessEntries/:databaseTableAccessEntryKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." }, { "name": "databaseTableAccessEntryKey", "value": "", "type": "path", "description": "The unique key that identifies the table access object. This is a system-generated identifier." } ] }, "docs": "Gets a database table access entry object by identifier." }, { "info": { "name": "Retrieves a list of all database view access objects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId/databaseViewAccessEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(accessType eq \"SELECT\") and (grantee eq \"ADMIN\")\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter should be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Retrieves a list of all database view access entries in Data Safe.\n\nThe ListDatabaseViewAccessEntries operation returns only the database view access objects for the specified security policy report.\nIf targetId is specified, it must match the target associated with the securityPolicyReportId path parameter; otherwise, the request is rejected.\n" }, { "info": { "name": "Gets a database view access object by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId/databaseViewAccessEntries/:databaseViewAccessEntryKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." }, { "name": "databaseViewAccessEntryKey", "value": "", "type": "path", "description": "The unique key that identifies the view access object. This is a system-generated identifier." } ] }, "docs": "Gets a database view access object by identifier." }, { "info": { "name": "Retrieves a list of all role grant paths for a user.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/securityPolicyReports/:securityPolicyReportId/roleGrantPaths", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "securityPolicyReportId", "value": "", "type": "path", "description": "The OCID of the security policy report resource." }, { "name": "grantee", "value": "", "type": "query", "description": "A filter to return only items that match the specified grantee." }, { "name": "grantedRole", "value": "", "type": "query", "description": "A filter to return only items that match the specified role." } ] }, "docs": "Retrieves a list of all role grant paths for a particular user.\n\nThe ListRoleGrantPaths operation returns only the role grant paths for the specified security policy report.\n" }, { "info": { "name": "Gets consolidated sensitive column analytics data based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveColumnAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs." }, { "name": "sensitiveTypeGroupId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the sensitive type group resource." }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize the sensitive columns." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets consolidated sensitive columns analytics data based on the specified query parameters.\n\nWhen you perform the ListSensitiveColumnAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the\nparameter accessLevel is set to ACCESSIBLE, then the operation returns 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 doe" }, { "info": { "name": "Gets the list of sensitive data models.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "sensitiveDataModelId", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified sensitive data model OCID." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for displayName is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." } ] }, "docs": "Gets a list of sensitive data models based on the specified query parameters.\n" }, { "info": { "name": "Creates a new sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery\nand adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model\nthat can be updated later.\n" }, { "info": { "name": "Gets the details of the specified sensitive data model.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ] }, "docs": "Gets the details of the specified sensitive data model." }, { "info": { "name": "Updates one or more attributes of the specified sensitive data model.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive\ndata model does not perform data discovery.\n" }, { "info": { "name": "Deletes the specified sensitive data model.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ] }, "docs": "Deletes the specified sensitive data model." }, { "info": { "name": "Moves the specified sensitive data model and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified sensitive data model and its dependent resources into a different compartment." }, { "info": { "name": "Downloads an already-generated file corresponding to the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/download", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads an already-generated file corresponding to the specified sensitive data model. Note that the\nGenerateSensitiveDataModelForDownload operation is a prerequisite for the DownloadSensitiveDataModel operation.\nUse GenerateSensitiveDataModelForDownload to generate a data model file and then use DownloadSensitiveDataModel\nto download the generated file.\n" }, { "info": { "name": "Downloads an already-generated discovery report for the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/downloadReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads an already-generated discovery report. Note that the GenerateDiscoveryReportForDownload operation is a\nprerequisite for the DownloadDiscoveryReport operation. Use GenerateDiscoveryReportForDownload to generate a discovery\nreport file and then use DownloadDiscoveryReport to download the generated file. By default, it downloads report for\nall the columns in a sensitive data model. Use the discoveryJobId attribute to download report for a specific discovery job.\n" }, { "info": { "name": "Generates a downloadable file corresponding to the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/generateDataModelForDownload", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a downloadable file corresponding to the specified sensitive data model. It's a prerequisite for the\nDownloadSensitiveDataModel operation. Use this endpoint to generate a data model file and then use DownloadSensitiveDataModel\nto download the generated file. Note that file generation and download are serial operations. The download operation\ncan't be invoked while the generate operation is in progress.\n" }, { "info": { "name": "Generates a downloadable discovery report.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/generateReportForDownload", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a downloadable discovery report. It's a prerequisite for the DownloadDiscoveryReport operation. Use this\nendpoint to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file.\nBy default, it generates report for all the columns in a sensitive data model. Use the discoveryJobId attribute\nto generate report for a specific discovery job.\n" }, { "info": { "name": "Uploads a sensitive data model file to update the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/actions/upload", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a sensitive data model file (also called template) to update the specified sensitive data model. To create\na new sensitive data model using a file, first use the CreateSensitiveDataModel operation to create an empty data model\nand then use this endpoint to upload the data model file. Note that the upload operation replaces the content of the\nspecified sensitive data model, including all the existing columns and their relationships, with the content of the file.\n" }, { "info": { "name": "Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/referentialRelations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "isSensitive", "value": "", "type": "query", "description": "Returns referential relations containing sensitive columns when true.\nReturns referential relations containing non sensitive columns when false.\n" }, { "name": "relationType", "value": "", "type": "query", "description": "A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE,\nit returns the sensitive columns that do not have any parent. The response includes the parent columns as\nwell as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the\nchild columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED,\nit returns all the child columns that have database-level (dictionary-defined) relationship with their parents.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for key is descending.\n" } ] }, "docs": "Gets a list of referential relations present in the specified sensitive data model based on the specified query parameters.\n" }, { "info": { "name": "Creates a new referential relation in the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/referentialRelations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new referential relation in the specified sensitive data model.\n" }, { "info": { "name": "Gets the details of the specified referential relation.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/referentialRelations/:referentialRelationKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "referentialRelationKey", "value": "", "type": "path", "description": "The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model.\n" } ] }, "docs": "Gets the details of the specified referential relation." }, { "info": { "name": "Deletes the specified referential relation.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/referentialRelations/:referentialRelationKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "referentialRelationKey", "value": "", "type": "path", "description": "The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model.\n" } ] }, "docs": "Deletes the specified referential relation." }, { "info": { "name": "Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUpdatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Search for resources that were updated after a specific date.\nSpecifying this parameter corresponding `timeUpdatedGreaterThanOrEqualTo`\nparameter will retrieve all resources updated after the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" }, { "name": "timeUpdatedLessThan", "value": "", "type": "query", "description": "Search for resources that were updated before a specific date.\nSpecifying this parameter corresponding `timeUpdatedLessThan`\nparameter will retrieve all resources updated before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n" }, { "name": "sensitiveColumnLifecycleState", "value": "", "type": "query", "description": "Filters the sensitive column resources with the given lifecycle state values." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "objectType", "value": "", "type": "query", "description": "A filter to return only items related to a specific object type." }, { "name": "dataType", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified data types." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the sensitive columns that match the specified status." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs." }, { "name": "parentColumnKey", "value": "", "type": "query", "description": "A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys." }, { "name": "relationType", "value": "", "type": "query", "description": "A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE,\nit returns the sensitive columns that do not have any parent. The response includes the parent columns as\nwell as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the\nchild columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED,\nit returns all the child columns that have database-level (dictionary-defined) relationship with their parents.\n" }, { "name": "columnGroup", "value": "", "type": "query", "description": "A filter to return only the sensitive columns that belong to the specified column group." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for schemaName, objectName, and columnName is ascending.\n" }, { "name": "isCaseInSensitive", "value": "", "type": "query", "description": "A boolean flag indicating whether the search should be case-insensitive.\nThe search is case-sensitive by default. Set this parameter to true to do case-insensitive search.\n" } ] }, "docs": "Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.\n" }, { "info": { "name": "Creates a new sensitive column in the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new sensitive column in the specified sensitive data model.\n" }, { "info": { "name": "Patches one or more columns in the specified sensitive data model.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more columns in the specified sensitive data model. Use it to create, update, or delete sensitive columns.\nTo create sensitive columns, use CreateSensitiveColumnDetails as the patch value. And to update sensitive columns,\nuse UpdateSensitiveColumnDetails as the patch value.\n" }, { "info": { "name": "Applies the results of a discovery job to the specified sensitive data model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns/actions/applyDiscoveryJobResults", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies the results of a discovery job to the specified sensitive data model. Note that the plannedAction attribute\nof discovery results is used for processing them. You should first use PatchDiscoveryJobResults to set the plannedAction\nattribute of the discovery results you want to process. ApplyDiscoveryJobResults automatically reads the plannedAction\nattribute and updates the sensitive data model to reflect the actions you planned.\n" }, { "info": { "name": "Gets the details of the specified sensitive column.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns/:sensitiveColumnKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "sensitiveColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model." } ] }, "docs": "Gets the details of the specified sensitive column." }, { "info": { "name": "Updates one or more attributes of the specified sensitive column.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns/:sensitiveColumnKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "sensitiveColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sensitive column." }, { "info": { "name": "Deletes the specified sensitive column.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveColumns/:sensitiveColumnKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "sensitiveColumnKey", "value": "", "type": "path", "description": "The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model." } ] }, "docs": "Deletes the specified sensitive column." }, { "info": { "name": "Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "objectName", "value": "", "type": "query", "description": "A filter to return only items related to a specific object name." }, { "name": "objectType", "value": "", "type": "query", "description": "A filter to return only items related to a specific object type." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" } ] }, "docs": "Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveSchemas", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). \nThe default order is ascending.\n" } ] }, "docs": "Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.\n" }, { "info": { "name": "Gets a list of sensitive type Ids present in the specified sensitive data model.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveDataModels/:sensitiveDataModelId/sensitiveTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveDataModelId", "value": "", "type": "path", "description": "The OCID of the sensitive data model." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "sortBy", "value": "", "type": "query", "description": "- The field to sort by. You can specify only one sorting parameter (sortorder).\nThe default order is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of sensitive type Ids present in the specified sensitive data model.\n" }, { "info": { "name": "Gets a list of sensitive type groups based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "sensitiveTypeGroupId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the sensitive type group resource." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for displayName is ascending.\n" } ] }, "docs": "Gets a list of sensitive type groups based on the specified query parameters.\n" }, { "info": { "name": "Creates a new sensitive type group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new sensitive type group.\n" }, { "info": { "name": "Gets the details of the specified sensitive type group.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." } ] }, "docs": "Gets the details of the specified sensitive type group.\n" }, { "info": { "name": "Updates one or more attributes of the specified sensitive type group.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sensitive type group." }, { "info": { "name": "Deletes the specified sensitive type group.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." } ] }, "docs": "Deletes the specified sensitive type group." }, { "info": { "name": "Moves the sensitive type group to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the sensitive type group to the specified compartment." }, { "info": { "name": "Sensitive types for the specified sensitive type group retrieved successfully.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId/groupedSensitiveTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets the list of sensitive type Ids present in the specified sensitive type group.\n" }, { "info": { "name": "Patches one or more sensitive types in a sensitive type group.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/sensitiveTypeGroups/:sensitiveTypeGroupId/groupedSensitiveTypes", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeGroupId", "value": "", "type": "path", "description": "The OCID of the sensitive type group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches one or more sensitive types in a sensitive type group. You can use this operation to add or remove\nsensitive type ids in a sensitive type group.\n" }, { "info": { "name": "Gets a list of sensitive types based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "sensitiveTypeId", "value": "", "type": "query", "description": "A filter to return only items related to a specific sensitive type OCID." }, { "name": "sensitiveTypeSource", "value": "", "type": "query", "description": "A filter to return the sensitive type resources based on the value of their source attribute." }, { "name": "entityType", "value": "", "type": "query", "description": "A filter to return the sensitive type resources based on the value of their entityType attribute." }, { "name": "parentCategoryId", "value": "", "type": "query", "description": "A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID." }, { "name": "defaultMaskingFormatId", "value": "", "type": "query", "description": "A filter to return only the sensitive types that have the default masking format identified by the specified OCID." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending.\nThe default order for displayName is ascending.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "isCommon", "value": "", "type": "query", "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" } ] }, "docs": "Gets a list of sensitive types based on the specified query parameters.\n" }, { "info": { "name": "Creates a new sensitive type.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category.\nWhile sensitive types are used for data discovery, sensitive categories are used for logically grouping the related\nor similar sensitive types.\n" }, { "info": { "name": "Uploads a sensitive types xml file to create new sensitive types in regions.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypes/actions/bulkCreateSensitiveTypes", "headers": [ { "name": "opc-compartment-id", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a sensitive types xml file (also called template) to create new sensitive types.\n" }, { "info": { "name": "Gets the details of the specified sensitive type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypes/:sensitiveTypeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeId", "value": "", "type": "path", "description": "The OCID of the sensitive type." } ] }, "docs": "Gets the details of the specified sensitive type." }, { "info": { "name": "Updates one or more attributes of the specified sensitive type.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sensitiveTypes/:sensitiveTypeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeId", "value": "", "type": "path", "description": "The OCID of the sensitive type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sensitive type." }, { "info": { "name": "Deletes the specified sensitive type.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveTypes/:sensitiveTypeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypeId", "value": "", "type": "path", "description": "The OCID of the sensitive type." } ] }, "docs": "Deletes the specified sensitive type." }, { "info": { "name": "Moves the specified sensitive type into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypes/:sensitiveTypeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sensitiveTypeId", "value": "", "type": "path", "description": "The OCID of the sensitive type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified sensitive type into a different compartment." }, { "info": { "name": "Retrieves a list of all sensitive types export based on the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypesExports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "sensitiveTypesExportId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the sensitive types export resource." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all sensitive types export in Data Safe based on the specified query parameters.\nThe ListSensitiveTypesExports operation returns only the sensitive types export in the specified `compartmentId`.\n" }, { "info": { "name": "Generates a downloadable file corresponding to the specified list of sensitive types.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypesExports", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Gets the details of the specified sensitive types export by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sensitiveTypesExports/:sensitiveTypesExportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypesExportId", "value": "", "type": "path", "description": "The OCID of the sensitive types export." } ] }, "docs": "Gets the details of the specified sensitive types export by identifier." }, { "info": { "name": "Updates one or more attributes of the specified sensitive types export.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sensitiveTypesExports/:sensitiveTypesExportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypesExportId", "value": "", "type": "path", "description": "The OCID of the sensitive types export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified sensitive types export." }, { "info": { "name": "Deletes the specified sensitive types export.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sensitiveTypesExports/:sensitiveTypesExportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypesExportId", "value": "", "type": "path", "description": "The OCID of the sensitive types export." } ] }, "docs": "Deletes the specified sensitive types export." }, { "info": { "name": "Moves the specified sensitive types export into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypesExports/:sensitiveTypesExportId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sensitiveTypesExportId", "value": "", "type": "path", "description": "The OCID of the sensitive types export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified sensitive types export into a different compartment." }, { "info": { "name": "Downloads an already-generated file corresponding to the specified sensitive types export", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sensitiveTypesExports/:sensitiveTypesExportId/actions/download", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sensitiveTypesExportId", "value": "", "type": "path", "description": "The OCID of the sensitive types export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads an already-generated file corresponding to the specified sensitive types export.\nUse CreateSensitiveTypesExport to generate an XML file and then use DownloadSensitiveTypesExport\nto download the generated file.\n" }, { "info": { "name": "Retrieves a list of all SQL collections.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlCollectionAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the SQL collection." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize SQL collection aggregation." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return the stats of the SQL collection logs collected after the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return the stats of the SQL collection logs collected before the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" } ] }, "docs": "Retrieves a list of all SQL collection analytics in Data Safe.\n\nThe ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of th" }, { "info": { "name": "Retrieves a list of all SQL collections.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlCollections", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the SQL collection." }, { "name": "sqlCollectionId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the SQL collection resource." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." }, { "name": "dbUserName", "value": "", "type": "query", "description": "A filter to return only items that match the specified user name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting parameter order (sortOrder) can be specified.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all SQL collections in Data Safe.\n\nThe ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is valid" }, { "info": { "name": "Creates a new SQL collection resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SQL collection resource.\n" }, { "info": { "name": "Gets a SQL collection by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Gets a SQL collection by identifier." }, { "info": { "name": "Updates the SQL collection.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the SQL collection." }, { "info": { "name": "Deletes the specified SQL collection.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Deletes the specified SQL collection." }, { "info": { "name": "Moves the specified SQL collection and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified SQL collection and its dependent resources into a different compartment." }, { "info": { "name": "Generates or appends to the SQL Firewall policy using the specified SQL collection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/generateSqlFirewallPolicy", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Generates or appends to the SQL Firewall policy using the specified SQL collection." }, { "info": { "name": "Purge the SQL collection logs for the specified SqlCollection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/purgeLogs", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Purge the SQL collection logs for the specified SqlCollection." }, { "info": { "name": "Refresh the specified SQL collection Log Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/refreshLogInsights", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Refresh the specified SQL collection Log Insights." }, { "info": { "name": "Starts the specified SQL collection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Start the specified SQL collection." }, { "info": { "name": "Stops the specified SQL collection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." } ] }, "docs": "Stops the specified SQL collection." }, { "info": { "name": "Retrieves a list of all SQL collections.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlCollections/:sqlCollectionId/logInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return the stats of the SQL collection logs collected after the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return the stats of the SQL collection logs collected before the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "sqlCollectionId", "value": "", "type": "path", "description": "The OCID of the SQL collection resource." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize SQL collection log insights aggregation." } ] }, "docs": "Retrieves a list of the SQL collection log analytics.\n" }, { "info": { "name": "Returns the aggregation details of all SQL Firewall allowed SQL statements.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqlAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(currentUser eq \"SCOTT\") and (topLevel eq \"YES\")\n" }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize the allowed SQL aggregation." } ] }, "docs": "Returns the aggregation details of all SQL Firewall allowed SQL statements.\n\nThe ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal d" }, { "info": { "name": "Retrieves a list of all SQL Firewall allowed SQL statements.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(currentUser eq \"SCOTT\") and (topLevel eq \"YES\")\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter should be provided.\n" } ] }, "docs": "Retrieves a list of all SQL Firewall allowed SQL statements.\n\nThe ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of th" }, { "info": { "name": "Delete multiple allowed sqls.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete multiple allowed sqls. You can use this operation to delete one or more allowed sqls.\nCreate and update of multiple allowed sqls is not supported.\n" }, { "info": { "name": "Appends the allowedSqls with entries from the logs.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls/actions/bulkCreate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Appends the allowedSqls with entries from the logs." }, { "info": { "name": "Delete multiple allowed sqls.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls/actions/bulkDelete", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete multiple allowed sqls from the SQL firewall policy." }, { "info": { "name": "Gets a SQL firewall allowed SQL by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls/:sqlFirewallAllowedSqlId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlFirewallAllowedSqlId", "value": "", "type": "path", "description": "The OCID of the sqlFirewallAllowedSql resource." } ] }, "docs": "Gets a SQL firewall allowed SQL by identifier." }, { "info": { "name": "Deletes the specified allowed sql.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sqlFirewallAllowedSqls/:sqlFirewallAllowedSqlId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlFirewallAllowedSqlId", "value": "", "type": "path", "description": "The OCID of the sqlFirewallAllowedSql resource." } ] }, "docs": "Deletes the specified allowed sql." }, { "info": { "name": "Retrieves a list of all SQL Firewall policies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the SQL Firewall policy." }, { "name": "sqlFirewallPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the SQL Firewall policy resource." }, { "name": "dbUserName", "value": "", "type": "query", "description": "A filter to return only items that match the specified user name." }, { "name": "violationAction", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified violation action." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all SQL Firewall policies.\n\nThe ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This is v" }, { "info": { "name": "Gets a SQL Firewall policy by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallPolicies/:sqlFirewallPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlFirewallPolicyId", "value": "", "type": "path", "description": "The OCID of the SQL Firewall policy resource." } ] }, "docs": "Gets a SQL Firewall policy by identifier." }, { "info": { "name": "Updates the SQL Firewall policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/sqlFirewallPolicies/:sqlFirewallPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlFirewallPolicyId", "value": "", "type": "path", "description": "The OCID of the SQL Firewall policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the SQL Firewall policy." }, { "info": { "name": "Deletes the SQL Firewall policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/sqlFirewallPolicies/:sqlFirewallPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlFirewallPolicyId", "value": "", "type": "path", "description": "The OCID of the SQL Firewall policy resource." } ] }, "docs": "Deletes the SQL Firewall policy resource.\n" }, { "info": { "name": "Moves the specified SQL Firewall policy and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/sqlFirewallPolicies/:sqlFirewallPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlFirewallPolicyId", "value": "", "type": "path", "description": "The OCID of the SQL Firewall policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified SQL Firewall policy and its dependent resources into a different compartment." }, { "info": { "name": "Summarizes the SQL Firewall policy information.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallPolicyAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "groupBy", "value": "", "type": "query", "description": "The group by parameter to summarize SQL Firewall policy aggregation." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the SQL Firewall policy." }, { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return the summary of the SQL Firewall policies created after the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return the summary of the SQL Firewall policies created before the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" } ] }, "docs": "Gets a list of aggregated SQL Firewall policy details.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nprincipal doesn't have access to even one of the child compartments. This is valid only when\n`compartmentIdInSubtree` is set to `true`.\n\nThe parameter `compartmentIdInSubtree` applie" }, { "info": { "name": "Returns the aggregation details of the SQL Firewall violations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallViolationAnalytics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "timeStarted", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "timeEnded", "value": "", "type": "query", "description": "An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified,\nin the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "name": "queryTimeZone", "value": "", "type": "query", "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.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is sorted by this query parameter value.\n" }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(operationTime ge \"2021-06-04T01:00:26.000Z\") and (violationAction eq \"BLOCKED\")\n" }, { "name": "summaryField", "value": "", "type": "query", "description": "Specifies a subset of summarized fields to be returned in the response." }, { "name": "groupBy", "value": "", "type": "query", "description": "A groupBy can only be used in combination with summaryField parameter.\nA groupBy value has to be a subset of the values mentioned in summaryField parameter.\n" } ] }, "docs": "Returns the aggregation details of the SQL Firewall violations.\n" }, { "info": { "name": "Gets a list of all the SQL Firewall violations captured by the firewall.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/sqlFirewallViolations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is sorted by this query parameter value.\n" }, { "name": "scimQuery", "value": "", "type": "query", "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:** query=(operationTime ge \"2021-06-04T01:00:26.000Z\") and (violationAction eq \"BLOCKED\")\n" } ] }, "docs": "Gets a list of all the SQL Firewall violations captured by the firewall.\n" }, { "info": { "name": "Gets a list of all target-alert policy associations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target-alert policy association ID." }, { "name": "alertPolicyId", "value": "", "type": "query", "description": "A filter to return policy by it's OCID." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "An optional filter to return only alert policies that have the given life-cycle state." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter may be provided.\n" }, { "name": "targetType", "value": "", "type": "query", "description": "A optional filter to return only resources that belong to the specified alert policy association type." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of all target-alert policy associations.\n" }, { "info": { "name": "Creates a new target-alert policy association to track a alert policy applied on target.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new target-alert policy association to track a alert policy applied on target.\n" }, { "info": { "name": "Creates new target-alert policy associations that will be applied on the target database.", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new target-alert policy associations that will be applied on the target database.\n" }, { "info": { "name": "Gets the details of the specified target-alert policy association.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations/:targetAlertPolicyAssociationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "path", "description": "The OCID of the target-alert policy association." } ] }, "docs": "Gets the details of target-alert policy association by its ID." }, { "info": { "name": "Updates the specified target-alert policy association.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations/:targetAlertPolicyAssociationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "path", "description": "The OCID of the target-alert policy association." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified target-alert policy association." }, { "info": { "name": "Deletes the specified target-alert policy Association.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations/:targetAlertPolicyAssociationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "path", "description": "The OCID of the target-alert policy association." } ] }, "docs": "Deletes the specified target-alert policy Association." }, { "info": { "name": "Moves the specified target-alert policy association into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations/:targetAlertPolicyAssociationId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "path", "description": "The OCID of the target-alert policy association." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified target-alert policy Association into a different compartment." }, { "info": { "name": "Gets the details of the specified target-alert policy association and its unassociated members.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetAlertPolicyAssociations/:targetAlertPolicyAssociationId/unassociatedTargetMembers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAlertPolicyAssociationId", "value": "", "type": "path", "description": "The OCID of the target-alert policy association." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter may be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Gets the details of target-alert policy association and its unassociated members by its ID." }, { "info": { "name": "Retrieves a list of target database groups according to the specified query parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabaseGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "filter", "value": "", "type": "query", "description": "The scim query filter 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.)\nEx:** filter=(targetDatabaseId eq 'ocid1.datasafetargetdatabase.oc1.iad.abuwcljr3u2va4ba5wek53idpe5qq5kkbigzclscc6mysfecxzjt5dgmxqza')\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The sorting field for your request. You can only specify a single sorting order (sortOrder). The default order for timeCreated is descending.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to retrieve resources that exclusively align with the designated lifecycle state." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." } ] }, "docs": "Retrieves a list of target database groups according to the specified query parameters.\n" }, { "info": { "name": "Creates a new target database group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabaseGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new target database group.\n" }, { "info": { "name": "Returns the details of the specified target database group.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabaseGroups/:targetDatabaseGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseGroupId", "value": "", "type": "path", "description": "The OCID of the specified target database group." } ] }, "docs": "Returns the details of the specified target database group.\n" }, { "info": { "name": "Updates one or more attributes of the specified target database group.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/targetDatabaseGroups/:targetDatabaseGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseGroupId", "value": "", "type": "path", "description": "The OCID of the specified target database group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified target database group." }, { "info": { "name": "Deletes the specified target database group.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/targetDatabaseGroups/:targetDatabaseGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseGroupId", "value": "", "type": "path", "description": "The OCID of the specified target database group." } ] }, "docs": "Deletes the specified target database group." }, { "info": { "name": "Moves the target database group to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabaseGroups/:targetDatabaseGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseGroupId", "value": "", "type": "path", "description": "The OCID of the specified target database group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the target database group to the specified compartment." }, { "info": { "name": "Retrieves the members of the target database group with the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabaseGroups/:targetDatabaseGroupId/groupMembers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseGroupId", "value": "", "type": "path", "description": "The OCID of the specified target database group." }, { "name": "targetDatabaseId", "value": "", "type": "query", "description": "A filter to return the target database only if it is a member of the target database group." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Retrieves the members of the target database group with the specified OCID.\n" }, { "info": { "name": "Returns the list of registered target databases in Data Safe.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "associatedResourceId", "value": "", "type": "query", "description": "A filter to return the target databases that are associated to the resource id passed in as a parameter value." }, { "name": "targetDatabaseId", "value": "", "type": "query", "description": "A filter to return the target database that matches the specified OCID." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only target databases that match the specified lifecycle state." }, { "name": "databaseType", "value": "", "type": "query", "description": "A filter to return only target databases that match the specified database type." }, { "name": "infrastructureType", "value": "", "type": "query", "description": "A filter to return only target databases that match the specified infrastructure type." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Returns the list of registered target databases in Data Safe.\n" }, { "info": { "name": "Registers the specified database with Data Safe and creates a target database in the Data Safe Console.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.\n" }, { "info": { "name": "Returns the details of the specified Data Safe target database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Returns the details of the specified Data Safe target database.\n" }, { "info": { "name": "Updates one or more attributes of the specified Data Safe target database.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Data Safe target database." }, { "info": { "name": "Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console." }, { "info": { "name": "Reactivates a previously deactivated Data Safe target database.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/activate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reactivates a previously deactivated Data Safe target database.\n" }, { "info": { "name": "Moves the Data Safe target database to the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Data Safe target database to the specified compartment." }, { "info": { "name": "Deactivates a target database in Data Safe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/deactivate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Deactivates a target database in Data Safe.\n" }, { "info": { "name": "Updates the Data Safe target database Privileges.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/managePrivileges", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Data Safe target database Privileges." }, { "info": { "name": "Refreshes the Data Safe target database to update it's state.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/refresh", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Refreshes the Data Safe target database to update it's state.\n" }, { "info": { "name": "Refresh dictionary data for the Data Safe target database.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/actions/refreshDictionaryObjects", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Refreshes the dictionary data of the target database.\n" }, { "info": { "name": "List metadata of columns from all the tables in the database registered as a target database in Data Safe console.\nThe target database is identified by id supplied as a path parameter.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/columns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "tableName", "value": "", "type": "query", "description": "A filter to return only items related to specific table name." }, { "name": "columnName", "value": "", "type": "query", "description": "A filter to return only a specific column based on column name." }, { "name": "datatype", "value": "", "type": "query", "description": "A filter to return only items related to specific datatype." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\n" }, { "name": "schemaNameContains", "value": "", "type": "query", "description": "A filter to return only items if schema name contains a specific string." }, { "name": "tableNameContains", "value": "", "type": "query", "description": "A filter to return only items if table name contains a specific string." }, { "name": "columnNameContains", "value": "", "type": "query", "description": "A filter to return only items if column name contains a specific string." } ] }, "docs": "Returns a list of column metadata objects.\n" }, { "info": { "name": "Gets the date and time the dictionary objects were last fetched from the database.\nThe target database is identified by id supplied as a path parameter.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/dictionary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ] }, "docs": "Returns dictionary.\n" }, { "info": { "name": "Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/peerTargetDatabases", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter." }, { "info": { "name": "Creates the peer target database under the primary target database in Data Safe.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/peerTargetDatabases", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the peer target database under the primary target database in Data Safe." }, { "info": { "name": "Returns the details of the specified Data Safe peer target database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/peerTargetDatabases/:peerTargetDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "peerTargetDatabaseId", "value": "", "type": "path", "description": "The unique id of the peer target database." } ] }, "docs": "Returns the details of the specified Data Safe peer target database.\n" }, { "info": { "name": "Updates one or more attributes of the specified Data Safe peer target database.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/peerTargetDatabases/:peerTargetDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "peerTargetDatabaseId", "value": "", "type": "path", "description": "The unique id of the peer target database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Data Safe peer target database." }, { "info": { "name": "Removes the specified peer target database from Data Safe.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/peerTargetDatabases/:peerTargetDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "peerTargetDatabaseId", "value": "", "type": "path", "description": "The unique id of the peer target database." } ] }, "docs": "Removes the specified peer target database from Data Safe." }, { "info": { "name": "List metadata of roles in the database registered as a target database in Data Safe console.\nThe target database is identified by id supplied as a path parameter.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/roles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "roleName", "value": "", "type": "query", "description": "A filter to return only a specific role based on role name." }, { "name": "isOracleMaintained", "value": "", "type": "query", "description": "A filter to return roles based on whether they are maintained by oracle or not." }, { "name": "authenticationType", "value": "", "type": "query", "description": "A filter to return roles based on authentication type." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\n" }, { "name": "roleNameContains", "value": "", "type": "query", "description": "A filter to return only items if role name contains a specific string." } ] }, "docs": "Returns a list of role metadata objects.\n" }, { "info": { "name": "List metadata of schema present in the database registered as a target database in Data Safe console.\nThe target database is identified by id supplied as a path parameter.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/schemas", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\n" }, { "name": "isOracleMaintained", "value": "", "type": "query", "description": "A filter to return only items related to specific type of schema." }, { "name": "schemaNameContains", "value": "", "type": "query", "description": "A filter to return only items if schema name contains a specific string." } ] }, "docs": "Returns list of schema.\n" }, { "info": { "name": "List metadata of tables in the database registered as a target database in Data Safe console.\nThe target database is identified by id supplied as a path parameter.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/targetDatabases/:targetDatabaseId/tables", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetDatabaseId", "value": "", "type": "path", "description": "The OCID of the Data Safe target database." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "schemaName", "value": "", "type": "query", "description": "A filter to return only items related to specific schema name." }, { "name": "tableName", "value": "", "type": "query", "description": "A filter to return only items related to specific table name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\n" }, { "name": "tableNameContains", "value": "", "type": "query", "description": "A filter to return only items if table name contains a specific string." }, { "name": "schemaNameContains", "value": "", "type": "query", "description": "A filter to return only items if schema name contains a specific string." } ] }, "docs": "Returns a list of table metadata objects.\n" }, { "info": { "name": "Retrieves a list of all Unified Audit policies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the security policy resource." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the Unified Audit policy." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "isSeeded", "value": "", "type": "query", "description": "A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource." }, { "name": "unifiedAuditPolicyId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the Unified Audit policy resource." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" } ] }, "docs": "Retrieves a list of all Unified Audit policies.\n\nThe ListUnifiedAuditPolicies operation returns only the Unified Audit policies in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequester has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a sub-compartment) or to return Not Authorized if\nPrincipal doesn't have access to even one of the child compartments. This " }, { "info": { "name": "Creates the specified unified audit policy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the specified unified audit policy.\n" }, { "info": { "name": "Bulk create unified audit policies.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies/actions/bulkCreate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk create unified audit policies." }, { "info": { "name": "Gets a Unified Audit policy by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies/:unifiedAuditPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyId", "value": "", "type": "path", "description": "The OCID of the Unified Audit policy resource." } ] }, "docs": "Gets a Unified Audit policy by identifier." }, { "info": { "name": "Updates the Unified Audit policy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies/:unifiedAuditPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyId", "value": "", "type": "path", "description": "The OCID of the Unified Audit policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Unified Audit policy." }, { "info": { "name": "Deletes the Unified Audit policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies/:unifiedAuditPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyId", "value": "", "type": "path", "description": "The OCID of the Unified Audit policy resource." } ] }, "docs": "Deletes the Unified Audit policy resource.\n" }, { "info": { "name": "Moves the specified Unified Audit policy and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/unifiedAuditPolicies/:unifiedAuditPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyId", "value": "", "type": "path", "description": "The OCID of the Unified Audit policy resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified Unified Audit policy and its dependent resources into a different compartment." }, { "info": { "name": "Retrieves a list of all unified audit policy definitions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/unifiedAuditPolicyDefinitions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the unified audit policy definition." }, { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "query", "description": "An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "isSeeded", "value": "", "type": "query", "description": "A boolean flag indicating to list seeded unified audit policy definitions. Set this parameter to get list of seeded unified audit policy definitions." }, { "name": "unifiedAuditPolicyCategory", "value": "", "type": "query", "description": "The category to which the unified audit policy definition belongs to." }, { "name": "unifiedAuditPolicyName", "value": "", "type": "query", "description": "The name of the unified audit policy." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Retrieves a list of all unified audit policy definitions in Data Safe.\n\nThe ListUnifiedAuditPolicyDefinitions operation returns only the unified audit policy definitions in the specified `compartmentId`.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequester has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access to " }, { "info": { "name": "Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/unifiedAuditPolicyDefinitions/:unifiedAuditPolicyDefinitionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "path", "description": "The OCID of the unified audit policy definition resource." } ] }, "docs": "Gets a unified audit policy definition by the specified OCID of the unified audit policy definition resource." }, { "info": { "name": "Updates the unified audit policy definition.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/unifiedAuditPolicyDefinitions/:unifiedAuditPolicyDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "path", "description": "The OCID of the unified audit policy definition resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the unified audit policy definition." }, { "info": { "name": "Deletes the specified Unified audit policy definition.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/unifiedAuditPolicyDefinitions/:unifiedAuditPolicyDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "path", "description": "The OCID of the unified audit policy definition resource." } ] }, "docs": "Deletes the specified Unified audit policy definition." }, { "info": { "name": "Moves the specified unified audit policy definition and its dependent resources into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/unifiedAuditPolicyDefinitions/:unifiedAuditPolicyDefinitionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "unifiedAuditPolicyDefinitionId", "value": "", "type": "path", "description": "The OCID of the unified audit policy definition resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified unified audit policy definition and its dependent resources into a different compartment." }, { "info": { "name": "Gets a list of user assessments. User assessments can be of type: LATEST, SAVED, SAVE_SCHEDULE, or COMPARTMENT.\nWhen 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.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the specified display name.\n" }, { "name": "scheduleUserAssessmentId", "value": "", "type": "query", "description": "The OCID of the user assessment of type SAVE_SCHEDULE." }, { "name": "isScheduleAssessment", "value": "", "type": "query", "description": "A filter to return only user assessments of type SAVE_SCHEDULE.\n" }, { "name": "isBaseline", "value": "", "type": "query", "description": "A filter to return only user assessments that are set as baseline." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only items that match the specified assessment type." }, { "name": "triggeredBy", "value": "", "type": "query", "description": "A filter to return user assessments that were created by either the system or by a user only." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\nUsing timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "Search for resources that were created before a specific date.\nSpecifying this parameter corresponding `timeCreatedLessThan`\nparameter will retrieve all resources created before the\nspecified created date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as\ndefined by RFC 3339.\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the user assessment." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending.\n" }, { "name": "targetType", "value": "", "type": "query", "description": "A filter to return only only target database resources or target database group resources." }, { "name": "targetDatabaseGroupId", "value": "", "type": "query", "description": "A filter to return the target database group that matches the specified OCID." } ] }, "docs": "Gets a list of user assessments.\n\nThe ListUserAssessments operation returns only the assessments in the specified `compartmentId`.\nThe list does not include any subcompartments of the compartmentId passed.\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if\nPrincipal doesn't have access t" }, { "info": { "name": "Creates a new saved user assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new saved user assessment for a target database or target database group in a compartment. It saves the latest assessment in the\nspecified compartment. If a schedule is passed in, this operation persists the latest assessment that exists at the defined\ndate and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, { "info": { "name": "Gets the details of the specified user assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ] }, "docs": "Gets a user assessment by identifier." }, { "info": { "name": "Updates one or more attributes of the specified user assessment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.\n" }, { "info": { "name": "Deletes the specified saved user assessment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ] }, "docs": "Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation\nListUserAssessments with filters \"type = save_schedule\".\nThat call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId.\nIf the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.\n" }, { "info": { "name": "Moves the specified saved user assessment or future scheduled assessments into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified saved user assessment or future scheduled assessments into a different compartment.\nTo start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with\nthe filters \"type = save_schedule\". That call returns the scheduleAssessmentId. Then call\nChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule\nare not be moved. However, all new saves will be associated " }, { "info": { "name": "Compares user assessments.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/compare", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Compares two user assessments. For this comparison, a user assessment can be a saved, a latest assessment, or a baseline.\nAs an example, it can be used to compare a user assessment saved or a latest assessment with a baseline.\n" }, { "info": { "name": "Downloads the report of the specified user assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/downloadReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first.\nPlease use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).\n" }, { "info": { "name": "Generates the report of the specified user assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/generateReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates the report of the specified user assessment. The report is available in PDF or XLS format.\nAfter generating the report, use DownloadUserAssessmentReport to download it in the preferred format.\n" }, { "info": { "name": "Runs a user assessment, updates the latest assessment, and saves it for future reference.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/refresh", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refreshes the latest assessment and saves it for future reference. This operation runs with a userAssessmentId of type LATEST.\nBefore you start, first call the ListUserAssessments operation with filter \"type = latest\" to get the user assessment ID for\nthe target's latest assessment.\n" }, { "info": { "name": "Sets the saved user assessment as the baseline in the compartment where the specified assessment resides.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/setBaseline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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'." }, { "info": { "name": "Removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/actions/unsetBaseline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the baseline setting for the saved user assessment associated with the targetId passed via body.\nIf 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.\nSets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.\n" }, { "info": { "name": "Gets the details of the comparison report for the provided user assessments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/comparison/:comparisonUserAssessmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "comparisonUserAssessmentId", "value": "", "type": "path", "description": "The OCID of the baseline user assessment." } ] }, "docs": "Gets the details of the comparison report for the user assessments submitted for comparison." }, { "info": { "name": "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\nspecified user assessment.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/passwordExpiryDateAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "userCategory", "value": "", "type": "query", "description": "A filter to return only items that match the specified user category." }, { "name": "timePasswordExpiryLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" } ] }, "docs": "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.\nIt internally uses the aforementioned userAnalytics api.\n\nWhen you perform the ListPasswordExpiryDateAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the\nparameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has READ\npermissions on at least one resourc" }, { "info": { "name": "Gets a list of user profile aggregated details in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/profileAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "profileName", "value": "", "type": "query", "description": "A filter to return only items that match the specified profile name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting order (sortOrder) can be specified.\nThe default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Gets a list of aggregated user profile details in the specified compartment. This provides information about the\noverall profiles available. For example, the user profile details include how many users have the profile assigned\nand do how many use password verification function. This data is especially useful content for dashboards or to support analytics.\n\nWhen you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the\nparameter accessLe" }, { "info": { "name": "Gets a list of user profiles available on a given or all the target(s) using user assessment id in a given compartment.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/profiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "profileName", "value": "", "type": "query", "description": "A filter to return only items that match the specified profile name." }, { "name": "isUserCreated", "value": "", "type": "query", "description": "An optional filter to return the user created profiles." }, { "name": "passwordVerificationFunction", "value": "", "type": "query", "description": "An optional filter to filter the profiles based on password verification function." }, { "name": "userCountGreaterThanOrEqual", "value": "", "type": "query", "description": "An optional filter to return the profiles having user count greater than or equal to the provided value.\n" }, { "name": "userCountLessThan", "value": "", "type": "query", "description": "An optional filter to return the profiles having user count less than the provided value.\n" }, { "name": "failedLoginAttemptsGreaterThanOrEqual", "value": "", "type": "query", "description": "An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "failedLoginAttemptsLessThan", "value": "", "type": "query", "description": "An optional filter to return the profiles having failed login attempts number less than the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "sessionsPerUserGreaterThanOrEqual", "value": "", "type": "query", "description": "An optional filter to return the profiles permitting the user to spawn multiple sessions having count.\ngreater than or equal to the provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "sessionsPerUserLessThan", "value": "", "type": "query", "description": "An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than\nthe provided value. String value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "inactiveAccountTimeGreaterThanOrEqual", "value": "", "type": "query", "description": "An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "inactiveAccountTimeLessThan", "value": "", "type": "query", "description": "An optional filter to return the profiles allowing inactive account time in days less than the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "passwordLockTimeGreaterThanOrEqual", "value": "", "type": "query", "description": "An optional filter to return the profiles having password lock number greater than or equal to the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "passwordLockTimeLessThan", "value": "", "type": "query", "description": "An optional filter to return the profiles having password lock number less than the provided value.\nString value is used for accommodating the \"UNLIMITED\" and \"DEFAULT\" values.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Gets a list of user profiles containing the profile details along with the target id and user counts.\n\nThe ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment\nid is provided, then profile information for all the targets belonging to the pertaining compartment is returned.\nThe list does not include any subcompartments of the compartment under consideration.\n\nThe parameter 'accessLevel' specifies whether to return only those compartme" }, { "info": { "name": "Details of given profile available on given target.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/profiles/:profileName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "profileName", "value": "", "type": "path", "description": "Profile name to get detailed information ." } ] }, "docs": "Lists the details of given profile available on the target.\n\nThe GetProfile operation returns only the profiles in the specified 'userAssessmentId'.\nThis does not include any subcompartments of the current compartment.\n" }, { "info": { "name": "Gets a list of user access aggregated details of the specified user assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/userAccessAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort parameter may be provided.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of aggregated user access analytics in the specified target in a compartment.\n" }, { "info": { "name": "Gets a list of user aggregated details of the specified user assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/userAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "userCategory", "value": "", "type": "query", "description": "A filter to return only items that match the specified user category." }, { "name": "userKey", "value": "", "type": "query", "description": "A filter to return only items that match the specified user key." }, { "name": "accountStatus", "value": "", "type": "query", "description": "A filter to return only items that match the specified account status." }, { "name": "authenticationType", "value": "", "type": "query", "description": "A filter to return only items that match the specified authentication type." }, { "name": "userName", "value": "", "type": "query", "description": "A filter to return only items that match the specified user name." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "timeLastLoginGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeLastLoginLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUserCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUserCreatedLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordLastChangedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordLastChangedLessThan", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordExpiryGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordExpiryLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending.\n" } ] }, "docs": "Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state.\nof database user security. For example, the user details include how many users have the DBA role and how many users are in\nthe critical category. This data is especially useful content for dashboards or to support analytics.\n\nWhen you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to \"true,\" and if the\nparameter accessLevel is se" }, { "info": { "name": "Gets a list of users of the specified user assessment. The result contains database user details such as user type, account status,\nlast login time, user creation time, authentication type, user profile, and when was the password last changed.\nIt also contains the user category derived from these user details and granted privileges.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/users", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" }, { "name": "userCategory", "value": "", "type": "query", "description": "A filter to return only items that match the specified user category." }, { "name": "userRole", "value": "", "type": "query", "description": "A filter to return only items that match the specified user role." }, { "name": "userProfile", "value": "", "type": "query", "description": "A filter to return only items that match the specified user profile." }, { "name": "userType", "value": "", "type": "query", "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" }, { "name": "userKey", "value": "", "type": "query", "description": "A filter to return only items that match the specified user key." }, { "name": "accountStatus", "value": "", "type": "query", "description": "A filter to return only items that match the specified account status." }, { "name": "authenticationType", "value": "", "type": "query", "description": "A filter to return only items that match the specified authentication type." }, { "name": "userName", "value": "", "type": "query", "description": "A filter to return only items that match the specified user name." }, { "name": "targetId", "value": "", "type": "query", "description": "A filter to return only items related to a specific target OCID." }, { "name": "timeLastLoginGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeLastLoginLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUserCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timeUserCreatedLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordLastChangedGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordLastChangedLessThan", "value": "", "type": "query", "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).\n\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordExpiryGreaterThanOrEqualTo", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "timePasswordExpiryLessThan", "value": "", "type": "query", "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).\n**Example:** 2016-12-19T16:39:57.600Z\n" }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending.\n" }, { "name": "schemaList", "value": "", "type": "query", "description": "A filter to return items that contain the specified schema list." }, { "name": "areAllSchemasAccessible", "value": "", "type": "query", "description": "A filter to return only items that match the criteria that all schemas can be accessed by a user." } ] }, "docs": "Gets a list of users of the specified user assessment. The result contains the database user details for each user, such\nas user type, account status, last login time, user creation time, authentication type, user profile, and the date and time\nof the latest password change. It also contains the user category derived from these user details as well as privileges\ngranted to each user.\n" }, { "info": { "name": "Gets a list of grants for a particular user in the specified user assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/userAssessments/:userAssessmentId/users/:userKey/grants", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userAssessmentId", "value": "", "type": "path", "description": "The OCID of the user assessment." }, { "name": "userKey", "value": "", "type": "path", "description": "The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user." }, { "name": "grantKey", "value": "", "type": "query", "description": "A filter to return only items that match the specified user grant key." }, { "name": "grantName", "value": "", "type": "query", "description": "A filter to return only items that match the specified user grant name." }, { "name": "privilegeType", "value": "", "type": "query", "description": "A filter to return only items that match the specified privilege grant type." }, { "name": "privilegeCategory", "value": "", "type": "query", "description": "A filter to return only items that match the specified user privilege category." }, { "name": "depthLevel", "value": "", "type": "query", "description": "A filter to return only items that match the specified user grant depth level." }, { "name": "depthLevelGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only items that are at a level greater than or equal to the specified user grant depth level." }, { "name": "depthLevelLessThan", "value": "", "type": "query", "description": "A filter to return only items that are at a level less than the specified user grant depth level." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending.\n" } ] }, "docs": "Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the\nprivilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to\nroles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers\nto get the userKey for a particular user.\n" }, { "info": { "name": "Gets a list of work requests.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the specified compartment OCID." }, { "name": "operationType", "value": "", "type": "query", "description": "A filter to return only work requests that match the specific operation type." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting. Only one sorting parameter can be specified.\nThe default order is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sorting order for the work requests, either ascending (ASC) or descending (DESC)." }, { "name": "resourceId", "value": "", "type": "query", "description": "A filter to return only work requests that match the specified resource OCID." }, { "name": "targetDatabaseId", "value": "", "type": "query", "description": "A filter to return only work requests that are associated to the specified target database OCID." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "limit", "value": "", "type": "query", "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)." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false.\nWhen set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.\nSetting this to ACCESSIBLE returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.\n" } ] }, "docs": "Gets a list of work requests.\n" }, { "info": { "name": "Gets the details of the specified work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets the details of the specified work request." }, { "info": { "name": "Cancel the specified work request.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Cancel the specified work request.\n" }, { "info": { "name": "Resume the given work request.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId/actions/resume", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.\n" }, { "info": { "name": "Suspend the given work request.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId/actions/suspend", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.\n" }, { "info": { "name": "Gets a list of errors for the specified work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "limit", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of errors for the specified work request.\n" }, { "info": { "name": "Gets a list of log entries for the specified work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20181201/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "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)." }, { "name": "limit", "value": "", "type": "query", "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)." } ] }, "docs": "Gets a list of log entries for the specified work request.\n" } ] } ], "bundled": true }