Oracle Cloud Infrastructure Documentation

Database API Gateway Configurations

Database API Gateway Configuration Administrators

The Database API Gateway Configuration Administrator is responsible for creating, updating, and managing Database API Gateway configurations.

To grant the required permissions in a specific compartment, add the following IAM policies. Replace <group_name> and <compartment_name> with your values.

Table 9-14 Administrator Policies

Policy Access Level 
allow group <group_name> to read 
database-tools-connections in 
compartment <compartment_name>
 To read Database Tools connections. 
allow group <group_name> to manage 
database-tools-database-api-gateway-configs 
in compartment <compartment_name>
 Create, update, and delete Database API Gateway configurations in the specified compartment.
Note

Database Tools connections are required when you define connection pools in a Database API Gateway configuration. See Creating a Connection to know how to create a connection.

Database API Gateway Configuration Users

The Database API Gateway Configuration User must belong to the Configuration Users group and needs read-only access to the Database API Gateway configuration at runtime. This role also requires read access to the related Database Tools connections and the Vault secrets those connections use.

Add the following IAM policies in the compartment that contains your resources. Replace <group_name> and <compartment_name> with your values.

Table 9-15 User Policies

Policy Access Level 
allow group <group_name> to read secret-family 
in compartment <compartment_name>
 To read secrets from Vault. 
allow group <group_name> to read 
database-tools-connections 
in compartment <compartment_name>
 To read Database Tools connections. 
allow group <group_name> to use 
database-tools-database-api-gateway-configs 
in compartment <compartment_name>
 To use Database API Gateway configurations. 
Allow group <group_name> to read 
autonomous-databases in 
compartment <compartment_name>
 To retrieve the wallet from Autonomous Database
Note

Database Tools connections must reference secrets stored in Vault (for example, database credentials). For more information, see Database Tools Prerequisites.