Manage Permission for Manual Access to Database (v1)
Use this API (v1) to manage permission for manual access to database by Oracle.
This topic describes the original version of this REST API. You can also use the simplified v2 version of the REST API. The v2 version contains all parameters in the payload and does not require URL encoding while calling the REST APIs. This makes the v2 API easier to use. The v2 version is backwards compatible.
This gives you the ability to allow or disallow Oracle personnel to manually access your database in emergency situations when an environment is unresponsive and you have not yet created a service request to investigate the issue.
In an emergency situation, Oracle follows an internal process whereby a high-level development executive, after an independent verification process, permits manual access to the database without your explicit approval. You can also prohibit Oracle from manually accessing the EPM Cloud database, even if a service request to remedy a database issue is open.
This API is version v1.
Required Roles
Service Administrator
REST Resource
PUT /interop/rest/{api_version}/services/dataaccess?accessType={allow|revoke}&disableEmergencyAccess={true|false}
Note:
Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.
The following table summarizes the request parameters.
Table 10-10 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
api_version |
Specific API version | Path | Yes | None |
accessType |
Allow or revoke the manual access to database by Oracle, where the value can be allow or revoke |
Query | Yes | None |
disableEmergencyAccess |
Whether to prohibit all manual access to the database. The possible values are true and false. Setting this parameter value to true stops Oracle from manually accessing the database even if a service request is open. Oracle does not recommend setting this parameter value to true because Oracle cannot access the database if access is required to troubleshoot and fix a down environment. If the environment is down, you will not be able to issue this REST API to allow Oracle to manually access the database.
|
Query | No | False |
Response
Supported Media Types: application/json
Table 10-11 Parameters
| Parameters | Description |
|---|---|
details |
In case of errors, details are published with the error string |
status |
See Migration Status Codes |
links |
Detailed information about the link |
href |
Links to API call |
action |
The HTTP call type |
rel |
Can be self and/or Job Status. If set to Job Status, you can use the href to get the status of the import operation
|
data |
Parameters as key value pairs passed in the request |
Example of Response Body
The following shows an example of the response body in JSON format.
Copy
{
"links": [1]
0: {
"rel":"self", "href":"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v1/services/dataaccess?accessType=allow&disableEmergencyAccess=true"
"data":"null",
"action":"PUT,
}-
-
"details":"null",
"status":"0"
}